Resources
post /filter-aware-metadata/continuous-variable
Returns equal interval, quantile and standard deviation based bin ranges and/or the median for a continuous variable over a specified range.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/filter-aware-metadata/continuous-variableRequest Body chevron_right expand_more
ContinuousVariableMetadataPostRequest ContinuousVariableMetadataPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ContinuousVariableMetadataSpec |
| config.variable* | object | Inherits: object |
| config.variable.entityId* | string | |
| config.variable.variableId* | string | |
| config.metadata* | array | |
| config.metadata[] | string | Enum:
|
200 OK chevron_right expand_more
ContinuousVariableMetadataPostResponse ContinuousVariableMetadataPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| binRanges | object | Inherits: object |
| binRanges.equalInterval* | array | |
| binRanges.equalInterval[] | object | Inherits: object |
| binRanges.equalInterval[].binStart* | string | |
| binRanges.equalInterval[].binEnd* | string | |
| binRanges.equalInterval[].binLabel* | string | |
| binRanges.quantile* | array | |
| binRanges.quantile[] | object | Inherits: object |
| binRanges.quantile[].binStart* | string | |
| binRanges.quantile[].binEnd* | string | |
| binRanges.quantile[].binLabel* | string | |
| binRanges.standardDeviation* | array | |
| binRanges.standardDeviation[] | object | Inherits: object |
| binRanges.standardDeviation[].binStart* | string | |
| binRanges.standardDeviation[].binEnd* | string | |
| binRanges.standardDeviation[].binLabel* | string | |
| median | number |
get /apps
200 OK chevron_right expand_more
AppsGetResponse AppsGetResponse
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| apps* | array | |
| apps[] | object | Inherits: lib.AppOverview |
| apps[].name* | string | |
| apps[].displayName* | string | |
| apps[].description* | string | |
| apps[].projects* | array | |
| apps[].projects[] | string | |
| apps[].computeName | string | |
| apps[].visualizations* | array | |
| apps[].visualizations[] | object | Inherits: lib.VisualizationOverview |
| apps[].visualizations[].name* | string | |
| apps[].visualizations[].displayName* | string | |
| apps[].visualizations[].description* | string | |
| apps[].visualizations[].projects* | array | |
| apps[].visualizations[].projects[] | string | |
| apps[].visualizations[].maxPanels* | number | |
| apps[].visualizations[].dataElementConstraints | array | |
| apps[].visualizations[].dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| apps[].visualizations[].dataElementConstraints[].//* | object | Inherits: object |
| apps[].visualizations[].dataElementConstraints[].//.isRequired* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isTemporal* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.minNumVars* | number | |
| apps[].visualizations[].dataElementConstraints[].//.maxNumVars* | number | |
| apps[].visualizations[].dataElementConstraints[].//.minNumValues* | number | |
| apps[].visualizations[].dataElementConstraints[].//.maxNumValues* | number | |
| apps[].visualizations[].dataElementConstraints[].//.allowedTypes | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: string |
| apps[].visualizations[].dataElementConstraints[].//.allowedShapes | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: string |
| apps[].visualizations[].dataElementConstraints[].//.description* | string | |
| apps[].visualizations[].dataElementDependencyOrder | array | |
| apps[].visualizations[].dataElementDependencyOrder[] | array | |
| apps[].visualizations[].dataElementDependencyOrder[][] | string |
post /apps/standalone-map/visualizations/map-markers
Returns data required to make Standalone Map markers
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map/visualizations/map-markersRequest Body chevron_right expand_more
StandaloneMapMarkersPostRequest StandaloneMapMarkersPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.StandaloneMapMarkersSpec |
| config.outputEntityId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
200 OK chevron_right expand_more
StandaloneMapMarkersPostResponse StandaloneMapMarkersPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.StandaloneMapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].overlayValues* | array | |
| mapElements[].overlayValues[] | object | Inherits: lib.BinRange |
| mapElements[].overlayValues[].binStart* | string | |
| mapElements[].overlayValues[].binEnd* | string | |
| mapElements[].overlayValues[].binLabel* | string | |
| mapElements[].overlayValues[].value* | number | |
| mapElements[].overlayValues[].count* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number |
post /apps/standalone-map/visualizations/map-markers/bubbles
Returns data required to make bubble markers.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map/visualizations/map-markers/bubblesRequest Body chevron_right expand_more
StandaloneMapBubblesPostRequest StandaloneMapBubblesPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Specification for map bubbles. Inherits: lib.StandaloneMapBubblesSpec |
| config.outputEntityId* | string | Entity whose cardinality will be reported per marker. |
| config.geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.overlayConfig | object | Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers. Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
200 OK chevron_right expand_more
StandaloneMapBubblesPostResponse StandaloneMapBubblesPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.ColoredMapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].overlayValue* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number |
post /apps/standalone-map/visualizations/map-markers/bubbles/legend
Returns data required to make bubble marker legends
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map/visualizations/map-markers/bubbles/legendRequest Body chevron_right expand_more
StandaloneMapBubblesLegendPostRequest StandaloneMapBubblesLegendPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.StandaloneMapBubblesLegendSpec |
| config.outputEntityId* | string | |
| config.colorLegendConfig* | object | Inherits: lib.OverlayLegendConfig |
| config.colorLegendConfig.geoAggregateVariable* | object | Inherits: object |
| config.colorLegendConfig.geoAggregateVariable.entityId* | string | |
| config.colorLegendConfig.geoAggregateVariable.variableId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* | string | |
| config.sizeConfig* | object | Inherits: lib.SizeLegendConfig |
| config.sizeConfig.geoAggregateVariable* | object | Inherits: object |
| config.sizeConfig.geoAggregateVariable.entityId* | string | |
| config.sizeConfig.geoAggregateVariable.variableId* | string |
200 OK chevron_right expand_more
StandaloneMapBubblesLegendPostResponse StandaloneMapBubblesLegendPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| minColorValue* | number | |
| maxColorValue* | number | |
| minSizeValue* | number | |
| maxSizeValue* | number |
post /apps/standalone-map/visualizations/map-markers/collections
Map marker endpoint for collection variables.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map/visualizations/map-markers/collectionsRequest Body chevron_right expand_more
StandaloneCollectionMapMarkerPostRequest StandaloneCollectionMapMarkerPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Specification for a map marker Inherits: lib.StandaloneCollectionMapMarkerSpec |
| config.outputEntityId* | string | Entity ID associated with collection variable of interest. |
| config.geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number | |
| config.collection* | object | Collection variable to use for markers. Inherits: object |
| config.collection.entityId* | string | |
| config.collection.collectionId* | string | |
| config.aggregationConfig* | object | Specification for how variable values will be aggregated into quantiative value shown in bar plot marker. Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| config.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.aggregationConfig.overlayVariable* | object | Inherits: object |
| config.aggregationConfig.overlayVariable.entityId* | string | |
| config.aggregationConfig.overlayVariable.variableId* | string | |
| config.selectedMemberVariables* | array | Variables in the provided collection for which marker data should be provided. |
| config.selectedMemberVariables[] | object | Inherits: object |
| config.selectedMemberVariables[].entityId* | string | |
| config.selectedMemberVariables[].variableId* | string |
200 OK chevron_right expand_more
StandaloneCollectionMapMarkerPostResponse StandaloneCollectionMapMarkerPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| markers* | array | |
| markers[] | object | Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar. Additional properties: Yes Inherits: object |
| markers[].entityCount* | number | |
| markers[].avgLat* | number | |
| markers[].avgLon* | number | |
| markers[].minLat* | number | |
| markers[].minLon* | number | |
| markers[].maxLat* | number | |
| markers[].maxLon* | number | |
| markers[].values* | array | |
| markers[].values[] | object | Additional properties: Yes Inherits: lib.CollectionMemberAggregate |
| markers[].values[].variableId* | string | |
| markers[].values[].mean* | number | |
| markers[].values[].median* | number | |
| markers[].values[].confidenceInterval* | object | Inherits: lib.NumberRange |
| markers[].values[].confidenceInterval.min* | number | |
| markers[].values[].confidenceInterval.max* | number | |
| markers[].values[].n* | number |
post /apps/standalone-map-xyrelationships/visualizations/scatterplot
Returns data required to create a floating scatterplot visualization in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-xyrelationships/visualizations/scatterplotRequest Body chevron_right expand_more
FloatingScatterplotPostRequest FloatingScatterplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingScatterplotSpec |
| config.outputEntityId* | string | |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
200 OK chevron_right expand_more
FloatingScatterplotPostResponse FloatingScatterplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.variables* | array | |
| scatterplot.variables[] | object | Inherits: object |
| scatterplot.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.variables[].variableSpec* | object | Inherits: object |
| scatterplot.variables[].variableSpec.entityId* | string | |
| scatterplot.variables[].variableSpec.variableId* | string | |
| scatterplot.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.variables[].dataType* | string | Enum:
Inherits: string |
| scatterplot.variables[].dataShape* | string | Enum:
Inherits: string |
| scatterplot.variables[].displayName | string | |
| scatterplot.variables[].displayRangeMin | any | |
| scatterplot.variables[].displayRangeMax | any | |
| scatterplot.variables[].vocabulary | array | |
| scatterplot.variables[].vocabulary[] | string | |
| scatterplot.variables[].isCollection* | boolean | |
| scatterplot.variables[].imputeZero* | boolean | |
| scatterplot.variables[].members | array | |
| scatterplot.variables[].members[] | object | Inherits: object |
| scatterplot.variables[].members[].entityId* | string | |
| scatterplot.variables[].members[].variableId* | string |
post /apps/standalone-map-xyrelationships/visualizations/lineplot
Returns data required to create a floating lineplot visualization in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-xyrelationships/visualizations/lineplotRequest Body chevron_right expand_more
FloatingLineplotPostRequest FloatingLineplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
FloatingLineplotPostResponse FloatingLineplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: object |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.variables* | array | |
| lineplot.variables[] | object | Inherits: object |
| lineplot.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.variables[].variableSpec* | object | Inherits: object |
| lineplot.variables[].variableSpec.entityId* | string | |
| lineplot.variables[].variableSpec.variableId* | string | |
| lineplot.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.variables[].dataType* | string | Enum:
Inherits: string |
| lineplot.variables[].dataShape* | string | Enum:
Inherits: string |
| lineplot.variables[].displayName | string | |
| lineplot.variables[].displayRangeMin | any | |
| lineplot.variables[].displayRangeMax | any | |
| lineplot.variables[].vocabulary | array | |
| lineplot.variables[].vocabulary[] | string | |
| lineplot.variables[].isCollection* | boolean | |
| lineplot.variables[].imputeZero* | boolean | |
| lineplot.variables[].members | array | |
| lineplot.variables[].members[] | object | Inherits: object |
| lineplot.variables[].members[].entityId* | string | |
| lineplot.variables[].members[].variableId* | string |
post /apps/standalone-map-xyrelationships/visualizations/timeseries
Returns data required to create a floating time series visualization in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-xyrelationships/visualizations/timeseriesRequest Body chevron_right expand_more
FloatingLineplotPostRequest FloatingLineplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
FloatingLineplotPostResponse FloatingLineplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: object |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.variables* | array | |
| lineplot.variables[] | object | Inherits: object |
| lineplot.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.variables[].variableSpec* | object | Inherits: object |
| lineplot.variables[].variableSpec.entityId* | string | |
| lineplot.variables[].variableSpec.variableId* | string | |
| lineplot.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.variables[].dataType* | string | Enum:
Inherits: string |
| lineplot.variables[].dataShape* | string | Enum:
Inherits: string |
| lineplot.variables[].displayName | string | |
| lineplot.variables[].displayRangeMin | any | |
| lineplot.variables[].displayRangeMax | any | |
| lineplot.variables[].vocabulary | array | |
| lineplot.variables[].vocabulary[] | string | |
| lineplot.variables[].isCollection* | boolean | |
| lineplot.variables[].imputeZero* | boolean | |
| lineplot.variables[].members | array | |
| lineplot.variables[].members[] | object | Inherits: object |
| lineplot.variables[].members[].entityId* | string | |
| lineplot.variables[].members[].variableId* | string |
post /apps/standalone-map-distributions/visualizations/histogram
Returns data required to create a floating histogram visualization in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-distributions/visualizations/histogramRequest Body chevron_right expand_more
FloatingHistogramPostRequest FloatingHistogramPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingHistogramSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
FloatingHistogramPostResponse FloatingHistogramPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: object |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.variables* | array | |
| histogram.variables[] | object | Inherits: object |
| histogram.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.variables[].variableSpec* | object | Inherits: object |
| histogram.variables[].variableSpec.entityId* | string | |
| histogram.variables[].variableSpec.variableId* | string | |
| histogram.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.variables[].dataType* | string | Enum:
Inherits: string |
| histogram.variables[].dataShape* | string | Enum:
Inherits: string |
| histogram.variables[].displayName | string | |
| histogram.variables[].displayRangeMin | any | |
| histogram.variables[].displayRangeMax | any | |
| histogram.variables[].vocabulary | array | |
| histogram.variables[].vocabulary[] | string | |
| histogram.variables[].isCollection* | boolean | |
| histogram.variables[].imputeZero* | boolean | |
| histogram.variables[].members | array | |
| histogram.variables[].members[] | object | Inherits: object |
| histogram.variables[].members[].entityId* | string | |
| histogram.variables[].members[].variableId* | string |
post /apps/standalone-map-distributions/visualizations/boxplot
Returns data required to create a floating boxplot visualization in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-distributions/visualizations/boxplotRequest Body chevron_right expand_more
FloatingBoxplotPostRequest FloatingBoxplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingBoxplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
200 OK chevron_right expand_more
FloatingBoxplotPostResponse FloatingBoxplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: object |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.variables* | array | |
| boxplot.variables[] | object | Inherits: object |
| boxplot.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.variables[].variableSpec* | object | Inherits: object |
| boxplot.variables[].variableSpec.entityId* | string | |
| boxplot.variables[].variableSpec.variableId* | string | |
| boxplot.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.variables[].dataType* | string | Enum:
Inherits: string |
| boxplot.variables[].dataShape* | string | Enum:
Inherits: string |
| boxplot.variables[].displayName | string | |
| boxplot.variables[].displayRangeMin | any | |
| boxplot.variables[].displayRangeMax | any | |
| boxplot.variables[].vocabulary | array | |
| boxplot.variables[].vocabulary[] | string | |
| boxplot.variables[].isCollection* | boolean | |
| boxplot.variables[].imputeZero* | boolean | |
| boxplot.variables[].members | array | |
| boxplot.variables[].members[] | object | Inherits: object |
| boxplot.variables[].members[].entityId* | string | |
| boxplot.variables[].members[].variableId* | string |
post /apps/standalone-map-countsandproportions/visualizations/barplot
Returns data required to create a floating bar plot visualization in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-countsandproportions/visualizations/barplotRequest Body chevron_right expand_more
FloatingBarplotPostRequest FloatingBarplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingBarplotSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string |
200 OK chevron_right expand_more
FloatingBarplotPostResponse FloatingBarplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: object |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.variables* | array | |
| barplot.variables[] | object | Inherits: object |
| barplot.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.variables[].variableSpec* | object | Inherits: object |
| barplot.variables[].variableSpec.entityId* | string | |
| barplot.variables[].variableSpec.variableId* | string | |
| barplot.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.variables[].dataType* | string | Enum:
Inherits: string |
| barplot.variables[].dataShape* | string | Enum:
Inherits: string |
| barplot.variables[].displayName | string | |
| barplot.variables[].displayRangeMin | any | |
| barplot.variables[].displayRangeMax | any | |
| barplot.variables[].vocabulary | array | |
| barplot.variables[].vocabulary[] | string | |
| barplot.variables[].isCollection* | boolean | |
| barplot.variables[].imputeZero* | boolean | |
| barplot.variables[].members | array | |
| barplot.variables[].members[] | object | Inherits: object |
| barplot.variables[].members[].entityId* | string | |
| barplot.variables[].members[].variableId* | string |
post /apps/standalone-map-countsandproportions/visualizations/conttable
Returns data required to create a floating RxC mosaic plot visualization in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-countsandproportions/visualizations/conttableRequest Body chevron_right expand_more
FloatingContTablePostRequest FloatingContTablePostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingContTableSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string |
200 OK chevron_right expand_more
FloatingContTablePostResponse FloatingContTablePostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: object |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.variables* | array | |
| mosaic.variables[] | object | Inherits: object |
| mosaic.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.variables[].variableSpec* | object | Inherits: object |
| mosaic.variables[].variableSpec.entityId* | string | |
| mosaic.variables[].variableSpec.variableId* | string | |
| mosaic.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.variables[].dataType* | string | Enum:
Inherits: string |
| mosaic.variables[].dataShape* | string | Enum:
Inherits: string |
| mosaic.variables[].displayName | string | |
| mosaic.variables[].displayRangeMin | any | |
| mosaic.variables[].displayRangeMax | any | |
| mosaic.variables[].vocabulary | array | |
| mosaic.variables[].vocabulary[] | string | |
| mosaic.variables[].isCollection* | boolean | |
| mosaic.variables[].imputeZero* | boolean | |
| mosaic.variables[].members | array | |
| mosaic.variables[].members[] | object | Inherits: object |
| mosaic.variables[].members[].entityId* | string | |
| mosaic.variables[].members[].variableId* | string | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string |
post /apps/standalone-map-continuous-collections/visualizations/lineplot
Returns data required to create a floating line plot visualization for continuous variable collections in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-continuous-collections/visualizations/lineplotRequest Body chevron_right expand_more
CollectionFloatingLineplotPostRequest CollectionFloatingLineplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
FloatingLineplotPostResponse FloatingLineplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: object |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.variables* | array | |
| lineplot.variables[] | object | Inherits: object |
| lineplot.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.variables[].variableSpec* | object | Inherits: object |
| lineplot.variables[].variableSpec.entityId* | string | |
| lineplot.variables[].variableSpec.variableId* | string | |
| lineplot.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.variables[].dataType* | string | Enum:
Inherits: string |
| lineplot.variables[].dataShape* | string | Enum:
Inherits: string |
| lineplot.variables[].displayName | string | |
| lineplot.variables[].displayRangeMin | any | |
| lineplot.variables[].displayRangeMax | any | |
| lineplot.variables[].vocabulary | array | |
| lineplot.variables[].vocabulary[] | string | |
| lineplot.variables[].isCollection* | boolean | |
| lineplot.variables[].imputeZero* | boolean | |
| lineplot.variables[].members | array | |
| lineplot.variables[].members[] | object | Inherits: object |
| lineplot.variables[].members[].entityId* | string | |
| lineplot.variables[].members[].variableId* | string |
post /apps/standalone-map-continuous-collections/visualizations/boxplot
Returns data required to create a floating box plot visualization for continuous variable collections in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-continuous-collections/visualizations/boxplotRequest Body chevron_right expand_more
CollectionFloatingBoxplotPostRequest CollectionFloatingBoxplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingBoxplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
200 OK chevron_right expand_more
FloatingBoxplotPostResponse FloatingBoxplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: object |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.variables* | array | |
| boxplot.variables[] | object | Inherits: object |
| boxplot.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.variables[].variableSpec* | object | Inherits: object |
| boxplot.variables[].variableSpec.entityId* | string | |
| boxplot.variables[].variableSpec.variableId* | string | |
| boxplot.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.variables[].dataType* | string | Enum:
Inherits: string |
| boxplot.variables[].dataShape* | string | Enum:
Inherits: string |
| boxplot.variables[].displayName | string | |
| boxplot.variables[].displayRangeMin | any | |
| boxplot.variables[].displayRangeMax | any | |
| boxplot.variables[].vocabulary | array | |
| boxplot.variables[].vocabulary[] | string | |
| boxplot.variables[].isCollection* | boolean | |
| boxplot.variables[].imputeZero* | boolean | |
| boxplot.variables[].members | array | |
| boxplot.variables[].members[] | object | Inherits: object |
| boxplot.variables[].members[].entityId* | string | |
| boxplot.variables[].members[].variableId* | string |
post /apps/standalone-map-continuous-collections/visualizations/histogram
Returns data required to create a floating histogram visualization for continuous variable collections in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-continuous-collections/visualizations/histogramRequest Body chevron_right expand_more
CollectionFloatingHistogramPostRequest CollectionFloatingHistogramPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingHistogramSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
FloatingHistogramPostResponse FloatingHistogramPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: object |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.variables* | array | |
| histogram.variables[] | object | Inherits: object |
| histogram.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.variables[].variableSpec* | object | Inherits: object |
| histogram.variables[].variableSpec.entityId* | string | |
| histogram.variables[].variableSpec.variableId* | string | |
| histogram.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.variables[].dataType* | string | Enum:
Inherits: string |
| histogram.variables[].dataShape* | string | Enum:
Inherits: string |
| histogram.variables[].displayName | string | |
| histogram.variables[].displayRangeMin | any | |
| histogram.variables[].displayRangeMax | any | |
| histogram.variables[].vocabulary | array | |
| histogram.variables[].vocabulary[] | string | |
| histogram.variables[].isCollection* | boolean | |
| histogram.variables[].imputeZero* | boolean | |
| histogram.variables[].members | array | |
| histogram.variables[].members[] | object | Inherits: object |
| histogram.variables[].members[].entityId* | string | |
| histogram.variables[].members[].variableId* | string |
post /apps/standalone-map-categorical-collections/visualizations/lineplot
Returns data required to create a floating line plot visualization for categorical variable collections in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-categorical-collections/visualizations/lineplotRequest Body chevron_right expand_more
CollectionFloatingLineplotPostRequest CollectionFloatingLineplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
FloatingLineplotPostResponse FloatingLineplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: object |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.variables* | array | |
| lineplot.variables[] | object | Inherits: object |
| lineplot.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.variables[].variableSpec* | object | Inherits: object |
| lineplot.variables[].variableSpec.entityId* | string | |
| lineplot.variables[].variableSpec.variableId* | string | |
| lineplot.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.variables[].dataType* | string | Enum:
Inherits: string |
| lineplot.variables[].dataShape* | string | Enum:
Inherits: string |
| lineplot.variables[].displayName | string | |
| lineplot.variables[].displayRangeMin | any | |
| lineplot.variables[].displayRangeMax | any | |
| lineplot.variables[].vocabulary | array | |
| lineplot.variables[].vocabulary[] | string | |
| lineplot.variables[].isCollection* | boolean | |
| lineplot.variables[].imputeZero* | boolean | |
| lineplot.variables[].members | array | |
| lineplot.variables[].members[] | object | Inherits: object |
| lineplot.variables[].members[].entityId* | string | |
| lineplot.variables[].members[].variableId* | string |
post /apps/standalone-map-categorical-collections/visualizations/barplot
Returns data required to create a floating bar plot visualization for categorical variable collections in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-categorical-collections/visualizations/barplotRequest Body chevron_right expand_more
CollectionFloatingBarplotPostRequest CollectionFloatingBarplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingBarplotSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string |
200 OK chevron_right expand_more
FloatingBarplotPostResponse FloatingBarplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: object |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.variables* | array | |
| barplot.variables[] | object | Inherits: object |
| barplot.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.variables[].variableSpec* | object | Inherits: object |
| barplot.variables[].variableSpec.entityId* | string | |
| barplot.variables[].variableSpec.variableId* | string | |
| barplot.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.variables[].dataType* | string | Enum:
Inherits: string |
| barplot.variables[].dataShape* | string | Enum:
Inherits: string |
| barplot.variables[].displayName | string | |
| barplot.variables[].displayRangeMin | any | |
| barplot.variables[].displayRangeMax | any | |
| barplot.variables[].vocabulary | array | |
| barplot.variables[].vocabulary[] | string | |
| barplot.variables[].isCollection* | boolean | |
| barplot.variables[].imputeZero* | boolean | |
| barplot.variables[].members | array | |
| barplot.variables[].members[] | object | Inherits: object |
| barplot.variables[].members[].entityId* | string | |
| barplot.variables[].members[].variableId* | string |
post /apps/standalone-map-categorical-collections/visualizations/conttable
Returns data required to create a floating RxC mosaic plot visualization for categorical variable collections in the Standalone Map
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/standalone-map-categorical-collections/visualizations/conttableRequest Body chevron_right expand_more
CollectionFloatingContTablePostRequest CollectionFloatingContTablePostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingContTableSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: lib.CollectionOverlayConfig |
| config.xAxisVariable.collection* | object | Inherits: object |
| config.xAxisVariable.collection.entityId* | string | |
| config.xAxisVariable.collection.collectionId* | string | |
| config.xAxisVariable.selectedMembers* | array | |
| config.xAxisVariable.selectedMembers[] | object | Inherits: object |
| config.xAxisVariable.selectedMembers[].entityId* | string | |
| config.xAxisVariable.selectedMembers[].variableId* | string |
200 OK chevron_right expand_more
FloatingContTablePostResponse FloatingContTablePostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: object |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.variables* | array | |
| mosaic.variables[] | object | Inherits: object |
| mosaic.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.variables[].variableSpec* | object | Inherits: object |
| mosaic.variables[].variableSpec.entityId* | string | |
| mosaic.variables[].variableSpec.variableId* | string | |
| mosaic.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.variables[].dataType* | string | Enum:
Inherits: string |
| mosaic.variables[].dataShape* | string | Enum:
Inherits: string |
| mosaic.variables[].displayName | string | |
| mosaic.variables[].displayRangeMin | any | |
| mosaic.variables[].displayRangeMax | any | |
| mosaic.variables[].vocabulary | array | |
| mosaic.variables[].vocabulary[] | string | |
| mosaic.variables[].isCollection* | boolean | |
| mosaic.variables[].imputeZero* | boolean | |
| mosaic.variables[].members | array | |
| mosaic.variables[].members[] | object | Inherits: object |
| mosaic.variables[].members[].entityId* | string | |
| mosaic.variables[].members[].variableId* | string | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string |
post /apps/pass/visualizations/map-markers
Returns data required to make MapVeu markers
Java impl- working
R impl- NA
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/map-markersRequest Body chevron_right expand_more
MapPostRequest MapPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MapSpec |
| config.outputEntityId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
200 OK chevron_right expand_more
MapPostResponse MapPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.MapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number | |
| config* | object | Inherits: object |
| config.completeCasesGeoVar* | number |
post /apps/pass/visualizations/table
Return a tabular report of one or more variables. In the request, filters must be a subclass of Filter
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/tableRequest Body chevron_right expand_more
TablePostRequest TablePostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.TableSpec |
| config.outputEntityId* | string | |
| config.outputVariable* | array | |
| config.outputVariable[] | object | Inherits: object |
| config.outputVariable[].entityId* | string | |
| config.outputVariable[].variableId* | string | |
| config.pagingConfig* | object | Additional properties: Yes Inherits: object |
| config.pagingConfig.numRows | integer | Format: int64 |
| config.pagingConfig.offset | integer | Format: int64 |
200 OK chevron_right expand_more
TablePostResponse TablePostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| columns* | array | |
| columns[] | object | Inherits: object |
| columns[].entityId* | string | |
| columns[].variableId* | string | |
| rows* | array | |
| rows[] | array | |
| rows[][] | string |
post /apps/pass/visualizations/scatterplot
Returns data required to create a scatterplot visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/scatterplotRequest Body chevron_right expand_more
ScatterplotPostRequest ScatterplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ScatterplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
200 OK chevron_right expand_more
ScatterplotPostResponse ScatterplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: lib.ScatterplotData |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.config* | object | Inherits: lib.PlotConfig |
| scatterplot.config.completeCasesAllVars* | number | |
| scatterplot.config.completeCasesAxesVars* | number | |
| scatterplot.config.variables* | array | |
| scatterplot.config.variables[] | object | Inherits: object |
| scatterplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].variableSpec* | object | Inherits: object |
| scatterplot.config.variables[].variableSpec.entityId* | string | |
| scatterplot.config.variables[].variableSpec.variableId* | string | |
| scatterplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].displayName | string | |
| scatterplot.config.variables[].displayRangeMin | any | |
| scatterplot.config.variables[].displayRangeMax | any | |
| scatterplot.config.variables[].vocabulary | array | |
| scatterplot.config.variables[].vocabulary[] | string | |
| scatterplot.config.variables[].isCollection* | boolean | |
| scatterplot.config.variables[].imputeZero* | boolean | |
| scatterplot.config.variables[].members | array | |
| scatterplot.config.variables[].members[] | object | Inherits: object |
| scatterplot.config.variables[].members[].entityId* | string | |
| scatterplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/pass/visualizations/densityplot
Returns data required to create a densityplot visualization
Java impl- NA
R impl- drafted, passing unit tests, not confirmed working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/densityplotRequest Body chevron_right expand_more
DensityplotPostRequest DensityplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.DensityplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
DensityplotPostResponse DensityplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| densityplot* | object | Inherits: object |
| densityplot.data* | array | |
| densityplot.data[] | object | Inherits: lib.DensityplotData |
| densityplot.data[].overlayVariableDetails | object | Inherits: object |
| densityplot.data[].overlayVariableDetails.entityId* | string | |
| densityplot.data[].overlayVariableDetails.variableId* | string | |
| densityplot.data[].overlayVariableDetails.value* | string | |
| densityplot.data[].facetVariableDetails | array | Max. items: 2 |
| densityplot.data[].facetVariableDetails[] | object | Inherits: object |
| densityplot.data[].facetVariableDetails[].entityId* | string | |
| densityplot.data[].facetVariableDetails[].variableId* | string | |
| densityplot.data[].facetVariableDetails[].value* | string | |
| densityplot.data[].densityY* | array | |
| densityplot.data[].densityY[] | number | |
| densityplot.data[].densityX* | array | |
| densityplot.data[].densityX[] | number | |
| densityplot.config* | object | Inherits: lib.PlotConfig |
| densityplot.config.completeCasesAllVars* | number | |
| densityplot.config.completeCasesAxesVars* | number | |
| densityplot.config.variables* | array | |
| densityplot.config.variables[] | object | Inherits: object |
| densityplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| densityplot.config.variables[].variableSpec* | object | Inherits: object |
| densityplot.config.variables[].variableSpec.entityId* | string | |
| densityplot.config.variables[].variableSpec.variableId* | string | |
| densityplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| densityplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| densityplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| densityplot.config.variables[].displayName | string | |
| densityplot.config.variables[].displayRangeMin | any | |
| densityplot.config.variables[].displayRangeMax | any | |
| densityplot.config.variables[].vocabulary | array | |
| densityplot.config.variables[].vocabulary[] | string | |
| densityplot.config.variables[].isCollection* | boolean | |
| densityplot.config.variables[].imputeZero* | boolean | |
| densityplot.config.variables[].members | array | |
| densityplot.config.variables[].members[] | object | Inherits: object |
| densityplot.config.variables[].members[].entityId* | string | |
| densityplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/pass/visualizations/timeseries
Returns data required to create a Time Series visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/timeseriesRequest Body chevron_right expand_more
LineplotPostRequest LineplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.LineplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
LineplotPostResponse LineplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: lib.LineplotData |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.config* | object | Inherits: lib.PlotConfig |
| lineplot.config.completeCasesAllVars* | number | |
| lineplot.config.completeCasesAxesVars* | number | |
| lineplot.config.variables* | array | |
| lineplot.config.variables[] | object | Inherits: object |
| lineplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.config.variables[].variableSpec* | object | Inherits: object |
| lineplot.config.variables[].variableSpec.entityId* | string | |
| lineplot.config.variables[].variableSpec.variableId* | string | |
| lineplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| lineplot.config.variables[].displayName | string | |
| lineplot.config.variables[].displayRangeMin | any | |
| lineplot.config.variables[].displayRangeMax | any | |
| lineplot.config.variables[].vocabulary | array | |
| lineplot.config.variables[].vocabulary[] | string | |
| lineplot.config.variables[].isCollection* | boolean | |
| lineplot.config.variables[].imputeZero* | boolean | |
| lineplot.config.variables[].members | array | |
| lineplot.config.variables[].members[] | object | Inherits: object |
| lineplot.config.variables[].members[].entityId* | string | |
| lineplot.config.variables[].members[].variableId* | string | |
| lineplot.config.binSlider | object | Inherits: lib.BinSlider |
| lineplot.config.binSlider.min* | number | |
| lineplot.config.binSlider.max* | number | |
| lineplot.config.binSlider.step* | number | |
| lineplot.config.binSpec | object | Inherits: lib.BinSpec |
| lineplot.config.binSpec.type | string | Enum:
|
| lineplot.config.binSpec.value | number | |
| lineplot.config.binSpec.units | string | Enum:
Inherits: string |
| lineplot.config.binSpec.range | union | |
| lineplot.config.binSpec.range | anyOf | Any of the following types. |
| lineplot.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| lineplot.config.binSpec.range{NumberRange}..min* | number | |
| lineplot.config.binSpec.range{NumberRange}..max* | number | |
| lineplot.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| lineplot.config.binSpec.range{DateRange}..min* | string | |
| lineplot.config.binSpec.range{DateRange}..max* | string | |
| lineplot.config.viewport | object | Inherits: lib.NumericViewport |
| lineplot.config.viewport.xMin* | string | |
| lineplot.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/pass/visualizations/lineplot
Returns data required to create a lineplot visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/lineplotRequest Body chevron_right expand_more
LineplotPostRequest LineplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.LineplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
LineplotPostResponse LineplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: lib.LineplotData |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.config* | object | Inherits: lib.PlotConfig |
| lineplot.config.completeCasesAllVars* | number | |
| lineplot.config.completeCasesAxesVars* | number | |
| lineplot.config.variables* | array | |
| lineplot.config.variables[] | object | Inherits: object |
| lineplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.config.variables[].variableSpec* | object | Inherits: object |
| lineplot.config.variables[].variableSpec.entityId* | string | |
| lineplot.config.variables[].variableSpec.variableId* | string | |
| lineplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| lineplot.config.variables[].displayName | string | |
| lineplot.config.variables[].displayRangeMin | any | |
| lineplot.config.variables[].displayRangeMax | any | |
| lineplot.config.variables[].vocabulary | array | |
| lineplot.config.variables[].vocabulary[] | string | |
| lineplot.config.variables[].isCollection* | boolean | |
| lineplot.config.variables[].imputeZero* | boolean | |
| lineplot.config.variables[].members | array | |
| lineplot.config.variables[].members[] | object | Inherits: object |
| lineplot.config.variables[].members[].entityId* | string | |
| lineplot.config.variables[].members[].variableId* | string | |
| lineplot.config.binSlider | object | Inherits: lib.BinSlider |
| lineplot.config.binSlider.min* | number | |
| lineplot.config.binSlider.max* | number | |
| lineplot.config.binSlider.step* | number | |
| lineplot.config.binSpec | object | Inherits: lib.BinSpec |
| lineplot.config.binSpec.type | string | Enum:
|
| lineplot.config.binSpec.value | number | |
| lineplot.config.binSpec.units | string | Enum:
Inherits: string |
| lineplot.config.binSpec.range | union | |
| lineplot.config.binSpec.range | anyOf | Any of the following types. |
| lineplot.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| lineplot.config.binSpec.range{NumberRange}..min* | number | |
| lineplot.config.binSpec.range{NumberRange}..max* | number | |
| lineplot.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| lineplot.config.binSpec.range{DateRange}..min* | string | |
| lineplot.config.binSpec.range{DateRange}..max* | string | |
| lineplot.config.viewport | object | Inherits: lib.NumericViewport |
| lineplot.config.viewport.xMin* | string | |
| lineplot.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/pass/visualizations/histogram
Returns data required to create a histogram visualization.
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/histogramRequest Body chevron_right expand_more
HistogramPostRequest HistogramPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.HistogramSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
HistogramPostResponse HistogramPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: lib.HistogramData |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.config* | object | Inherits: lib.PlotConfig |
| histogram.config.completeCasesAllVars* | number | |
| histogram.config.completeCasesAxesVars* | number | |
| histogram.config.variables* | array | |
| histogram.config.variables[] | object | Inherits: object |
| histogram.config.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.config.variables[].variableSpec* | object | Inherits: object |
| histogram.config.variables[].variableSpec.entityId* | string | |
| histogram.config.variables[].variableSpec.variableId* | string | |
| histogram.config.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.config.variables[].dataType* | string | Enum:
Inherits: string |
| histogram.config.variables[].dataShape* | string | Enum:
Inherits: string |
| histogram.config.variables[].displayName | string | |
| histogram.config.variables[].displayRangeMin | any | |
| histogram.config.variables[].displayRangeMax | any | |
| histogram.config.variables[].vocabulary | array | |
| histogram.config.variables[].vocabulary[] | string | |
| histogram.config.variables[].isCollection* | boolean | |
| histogram.config.variables[].imputeZero* | boolean | |
| histogram.config.variables[].members | array | |
| histogram.config.variables[].members[] | object | Inherits: object |
| histogram.config.variables[].members[].entityId* | string | |
| histogram.config.variables[].members[].variableId* | string | |
| histogram.config.binSlider* | object | Inherits: lib.BinSlider |
| histogram.config.binSlider.min* | number | |
| histogram.config.binSlider.max* | number | |
| histogram.config.binSlider.step* | number | |
| histogram.config.binSpec* | object | Inherits: lib.BinSpec |
| histogram.config.binSpec.type | string | Enum:
|
| histogram.config.binSpec.value | number | |
| histogram.config.binSpec.units | string | Enum:
Inherits: string |
| histogram.config.binSpec.range | union | |
| histogram.config.binSpec.range | anyOf | Any of the following types. |
| histogram.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| histogram.config.binSpec.range{NumberRange}..min* | number | |
| histogram.config.binSpec.range{NumberRange}..max* | number | |
| histogram.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| histogram.config.binSpec.range{DateRange}..min* | string | |
| histogram.config.binSpec.range{DateRange}..max* | string | |
| histogram.config.summary* | object | Additional properties: Yes Inherits: object |
| histogram.config.summary.min* | string | |
| histogram.config.summary.q1* | string | |
| histogram.config.summary.median* | string | |
| histogram.config.summary.mean* | string | |
| histogram.config.summary.q3* | string | |
| histogram.config.summary.max* | string | |
| histogram.config.viewport* | object | Inherits: lib.NumericViewport |
| histogram.config.viewport.xMin* | string | |
| histogram.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/pass/visualizations/boxplot
Returns data required to create a boxplot visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/boxplotRequest Body chevron_right expand_more
BoxplotPostRequest BoxplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BoxplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
200 OK chevron_right expand_more
BoxplotPostResponse BoxplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: lib.BoxplotData |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.config* | object | Inherits: lib.PlotConfig |
| boxplot.config.completeCasesAllVars* | number | |
| boxplot.config.completeCasesAxesVars* | number | |
| boxplot.config.variables* | array | |
| boxplot.config.variables[] | object | Inherits: object |
| boxplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.config.variables[].variableSpec* | object | Inherits: object |
| boxplot.config.variables[].variableSpec.entityId* | string | |
| boxplot.config.variables[].variableSpec.variableId* | string | |
| boxplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| boxplot.config.variables[].displayName | string | |
| boxplot.config.variables[].displayRangeMin | any | |
| boxplot.config.variables[].displayRangeMax | any | |
| boxplot.config.variables[].vocabulary | array | |
| boxplot.config.variables[].vocabulary[] | string | |
| boxplot.config.variables[].isCollection* | boolean | |
| boxplot.config.variables[].imputeZero* | boolean | |
| boxplot.config.variables[].members | array | |
| boxplot.config.variables[].members[] | object | Inherits: object |
| boxplot.config.variables[].members[].entityId* | string | |
| boxplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: lib.BoxplotStatsTable |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].xVariableDetails | object | Inherits: object |
| statsTable[].xVariableDetails.entityId* | string | |
| statsTable[].xVariableDetails.variableId* | string | |
| statsTable[].xVariableDetails.value* | string | |
| statsTable[].statistic* | string | |
| statsTable[].pvalue* | number | |
| statsTable[].parameter* | array | |
| statsTable[].parameter[] | number | |
| statsTable[].method* | string | |
| statsTable[].statsError* | string |
post /apps/pass/visualizations/heatmap
Returns data required to create a heatmap visualization
Java impl- NA
R impl- drafted
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/heatmapRequest Body chevron_right expand_more
HeatmapPostRequest HeatmapPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.HeatmapSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.zAxisVariable | object | Inherits: object |
| config.zAxisVariable.entityId* | string | |
| config.zAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
HeatmapPostResponse HeatmapPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| heatmap* | object | Inherits: object |
| heatmap.data* | array | |
| heatmap.data[] | object | Inherits: lib.HeatmapData |
| heatmap.data[].facetVariableDetails | array | Max. items: 2 |
| heatmap.data[].facetVariableDetails[] | object | Inherits: object |
| heatmap.data[].facetVariableDetails[].entityId* | string | |
| heatmap.data[].facetVariableDetails[].variableId* | string | |
| heatmap.data[].facetVariableDetails[].value* | string | |
| heatmap.data[].value* | array | |
| heatmap.data[].value[] | array | |
| heatmap.data[].value[][] | number | |
| heatmap.data[].label* | array | |
| heatmap.data[].label[] | string | |
| heatmap.config* | object | Inherits: lib.PlotConfig |
| heatmap.config.completeCasesAllVars* | number | |
| heatmap.config.completeCasesAxesVars* | number | |
| heatmap.config.variables* | array | |
| heatmap.config.variables[] | object | Inherits: object |
| heatmap.config.variables[].variableClass* | string | Enum:
Inherits: string |
| heatmap.config.variables[].variableSpec* | object | Inherits: object |
| heatmap.config.variables[].variableSpec.entityId* | string | |
| heatmap.config.variables[].variableSpec.variableId* | string | |
| heatmap.config.variables[].plotReference* | string | Enum:
Inherits: string |
| heatmap.config.variables[].dataType* | string | Enum:
Inherits: string |
| heatmap.config.variables[].dataShape* | string | Enum:
Inherits: string |
| heatmap.config.variables[].displayName | string | |
| heatmap.config.variables[].displayRangeMin | any | |
| heatmap.config.variables[].displayRangeMax | any | |
| heatmap.config.variables[].vocabulary | array | |
| heatmap.config.variables[].vocabulary[] | string | |
| heatmap.config.variables[].isCollection* | boolean | |
| heatmap.config.variables[].imputeZero* | boolean | |
| heatmap.config.variables[].members | array | |
| heatmap.config.variables[].members[] | object | Inherits: object |
| heatmap.config.variables[].members[].entityId* | string | |
| heatmap.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/pass/visualizations/barplot
Returns data required to create a bar plot visualization
Java impl- drafted, not working
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/barplotRequest Body chevron_right expand_more
BarplotPostRequest BarplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BarplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
BarplotPostResponse BarplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: lib.BarplotData |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.config* | object | Inherits: lib.PlotConfig |
| barplot.config.completeCasesAllVars* | number | |
| barplot.config.completeCasesAxesVars* | number | |
| barplot.config.variables* | array | |
| barplot.config.variables[] | object | Inherits: object |
| barplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.config.variables[].variableSpec* | object | Inherits: object |
| barplot.config.variables[].variableSpec.entityId* | string | |
| barplot.config.variables[].variableSpec.variableId* | string | |
| barplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| barplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| barplot.config.variables[].displayName | string | |
| barplot.config.variables[].displayRangeMin | any | |
| barplot.config.variables[].displayRangeMax | any | |
| barplot.config.variables[].vocabulary | array | |
| barplot.config.variables[].vocabulary[] | string | |
| barplot.config.variables[].isCollection* | boolean | |
| barplot.config.variables[].imputeZero* | boolean | |
| barplot.config.variables[].members | array | |
| barplot.config.variables[].members[] | object | Inherits: object |
| barplot.config.variables[].members[].entityId* | string | |
| barplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/pass/visualizations/map-markers-overlay
Returns data required to create a pie plot visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/map-markers-overlayRequest Body chevron_right expand_more
MapMarkersOverlayPostRequest MapMarkersOverlayPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MapMarkersOverlaySpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingness |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.longitudeVariable | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
200 OK chevron_right expand_more
MapMarkersOverlayPostResponse MapMarkersOverlayPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mapMarkers* | object | Inherits: object |
| mapMarkers.data* | array | |
| mapMarkers.data[] | object | Inherits: lib.MapMarkersOverlayData |
| mapMarkers.data[].facetVariableDetails | array | Max. items: 2 |
| mapMarkers.data[].facetVariableDetails[] | object | Inherits: object |
| mapMarkers.data[].facetVariableDetails[].entityId* | string | |
| mapMarkers.data[].facetVariableDetails[].variableId* | string | |
| mapMarkers.data[].facetVariableDetails[].value* | string | |
| mapMarkers.data[].value* | array | |
| mapMarkers.data[].value[] | number | |
| mapMarkers.data[].label* | array | |
| mapMarkers.data[].label[] | string | |
| mapMarkers.config* | object | Inherits: lib.PlotConfig |
| mapMarkers.config.completeCasesAllVars* | number | |
| mapMarkers.config.completeCasesAxesVars* | number | |
| mapMarkers.config.variables* | array | |
| mapMarkers.config.variables[] | object | Inherits: object |
| mapMarkers.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].variableSpec* | object | Inherits: object |
| mapMarkers.config.variables[].variableSpec.entityId* | string | |
| mapMarkers.config.variables[].variableSpec.variableId* | string | |
| mapMarkers.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].dataType* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].dataShape* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].displayName | string | |
| mapMarkers.config.variables[].displayRangeMin | any | |
| mapMarkers.config.variables[].displayRangeMax | any | |
| mapMarkers.config.variables[].vocabulary | array | |
| mapMarkers.config.variables[].vocabulary[] | string | |
| mapMarkers.config.variables[].isCollection* | boolean | |
| mapMarkers.config.variables[].imputeZero* | boolean | |
| mapMarkers.config.variables[].members | array | |
| mapMarkers.config.variables[].members[] | object | Inherits: object |
| mapMarkers.config.variables[].members[].entityId* | string | |
| mapMarkers.config.variables[].members[].variableId* | string | |
| mapMarkers.config.viewport* | object | Inherits: lib.GeolocationViewport |
| mapMarkers.config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| mapMarkers.config.viewport.latitude.xMin* | string | |
| mapMarkers.config.viewport.latitude.xMax* | string | |
| mapMarkers.config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| mapMarkers.config.viewport.longitude.left* | number | |
| mapMarkers.config.viewport.longitude.right* | number | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/pass/visualizations/twobytwo
Returns data required to create a mosaic plot visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/twobytwoRequest Body chevron_right expand_more
TwoByTwoPostRequest TwoByTwoPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.xAxisReferenceValue* | string | |
| config.yAxisReferenceValue* | string |
200 OK chevron_right expand_more
TwoByTwoPostResponse TwoByTwoPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: object |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: string |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: object |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/pass/visualizations/conttable
Returns data required to create a mosaic plot visualization
Java impl- NA
R impl- drafted
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/pass/visualizations/conttableRequest Body chevron_right expand_more
MosaicPostRequest MosaicPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
ContTablePostResponse ContTablePostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: object |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: string |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: object |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].pvalue* | array | |
| statsTable[].pvalue[] | number | |
| statsTable[].degreesFreedom* | array | |
| statsTable[].degreesFreedom[] | number | |
| statsTable[].chisq* | array | |
| statsTable[].chisq[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/alphadiv/visualizations/boxplot
Returns data required to create a box plot with alpha diversity as dependent axis
Java impl- NA
R impl- NA
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/alphadiv/visualizations/boxplotRequest Body chevron_right expand_more
AlphaDivBoxplotPostRequest AlphaDivBoxplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
| config* | object | Inherits: lib.BoxplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
BoxplotPostResponse BoxplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: lib.BoxplotData |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.config* | object | Inherits: lib.PlotConfig |
| boxplot.config.completeCasesAllVars* | number | |
| boxplot.config.completeCasesAxesVars* | number | |
| boxplot.config.variables* | array | |
| boxplot.config.variables[] | object | Inherits: object |
| boxplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.config.variables[].variableSpec* | object | Inherits: object |
| boxplot.config.variables[].variableSpec.entityId* | string | |
| boxplot.config.variables[].variableSpec.variableId* | string | |
| boxplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| boxplot.config.variables[].displayName | string | |
| boxplot.config.variables[].displayRangeMin | any | |
| boxplot.config.variables[].displayRangeMax | any | |
| boxplot.config.variables[].vocabulary | array | |
| boxplot.config.variables[].vocabulary[] | string | |
| boxplot.config.variables[].isCollection* | boolean | |
| boxplot.config.variables[].imputeZero* | boolean | |
| boxplot.config.variables[].members | array | |
| boxplot.config.variables[].members[] | object | Inherits: object |
| boxplot.config.variables[].members[].entityId* | string | |
| boxplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: lib.BoxplotStatsTable |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].xVariableDetails | object | Inherits: object |
| statsTable[].xVariableDetails.entityId* | string | |
| statsTable[].xVariableDetails.variableId* | string | |
| statsTable[].xVariableDetails.value* | string | |
| statsTable[].statistic* | string | |
| statsTable[].pvalue* | number | |
| statsTable[].parameter* | array | |
| statsTable[].parameter[] | number | |
| statsTable[].method* | string | |
| statsTable[].statsError* | string |
post /apps/alphadiv/visualizations/scatterplot
Returns data required to create a scatterplot that explores the relationship between a continuous variable and alpha diversity
Java impl- NA
R impl- NA
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/alphadiv/visualizations/scatterplotRequest Body chevron_right expand_more
AlphaDivScatterplotPostRequest AlphaDivScatterplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
| config* | object | Inherits: lib.ScatterplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
ScatterplotPostResponse ScatterplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: lib.ScatterplotData |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.config* | object | Inherits: lib.PlotConfig |
| scatterplot.config.completeCasesAllVars* | number | |
| scatterplot.config.completeCasesAxesVars* | number | |
| scatterplot.config.variables* | array | |
| scatterplot.config.variables[] | object | Inherits: object |
| scatterplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].variableSpec* | object | Inherits: object |
| scatterplot.config.variables[].variableSpec.entityId* | string | |
| scatterplot.config.variables[].variableSpec.variableId* | string | |
| scatterplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].displayName | string | |
| scatterplot.config.variables[].displayRangeMin | any | |
| scatterplot.config.variables[].displayRangeMax | any | |
| scatterplot.config.variables[].vocabulary | array | |
| scatterplot.config.variables[].vocabulary[] | string | |
| scatterplot.config.variables[].isCollection* | boolean | |
| scatterplot.config.variables[].imputeZero* | boolean | |
| scatterplot.config.variables[].members | array | |
| scatterplot.config.variables[].members[] | object | Inherits: object |
| scatterplot.config.variables[].members[].entityId* | string | |
| scatterplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/abundance/visualizations/boxplot
Returns data required to create a box plot with abundance as dependent axis
Java impl- NA
R impl- NA
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/abundance/visualizations/boxplotRequest Body chevron_right expand_more
AbundanceBoxplotPostRequest AbundanceBoxplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
| config* | object | Inherits: lib.BoxplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
BoxplotPostResponse BoxplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: lib.BoxplotData |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.config* | object | Inherits: lib.PlotConfig |
| boxplot.config.completeCasesAllVars* | number | |
| boxplot.config.completeCasesAxesVars* | number | |
| boxplot.config.variables* | array | |
| boxplot.config.variables[] | object | Inherits: object |
| boxplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.config.variables[].variableSpec* | object | Inherits: object |
| boxplot.config.variables[].variableSpec.entityId* | string | |
| boxplot.config.variables[].variableSpec.variableId* | string | |
| boxplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| boxplot.config.variables[].displayName | string | |
| boxplot.config.variables[].displayRangeMin | any | |
| boxplot.config.variables[].displayRangeMax | any | |
| boxplot.config.variables[].vocabulary | array | |
| boxplot.config.variables[].vocabulary[] | string | |
| boxplot.config.variables[].isCollection* | boolean | |
| boxplot.config.variables[].imputeZero* | boolean | |
| boxplot.config.variables[].members | array | |
| boxplot.config.variables[].members[] | object | Inherits: object |
| boxplot.config.variables[].members[].entityId* | string | |
| boxplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: lib.BoxplotStatsTable |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].xVariableDetails | object | Inherits: object |
| statsTable[].xVariableDetails.entityId* | string | |
| statsTable[].xVariableDetails.variableId* | string | |
| statsTable[].xVariableDetails.value* | string | |
| statsTable[].statistic* | string | |
| statsTable[].pvalue* | number | |
| statsTable[].parameter* | array | |
| statsTable[].parameter[] | number | |
| statsTable[].method* | string | |
| statsTable[].statsError* | string |
post /apps/abundance/visualizations/scatterplot
Returns data required to create a scatterplot that explores the relationship between a continuous variable and alpha diversity
Java impl- NA
R impl- NA
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/abundance/visualizations/scatterplotRequest Body chevron_right expand_more
AbundanceScatterplotPostRequest AbundanceScatterplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
| config* | object | Inherits: lib.ScatterplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
ScatterplotPostResponse ScatterplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: lib.ScatterplotData |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.config* | object | Inherits: lib.PlotConfig |
| scatterplot.config.completeCasesAllVars* | number | |
| scatterplot.config.completeCasesAxesVars* | number | |
| scatterplot.config.variables* | array | |
| scatterplot.config.variables[] | object | Inherits: object |
| scatterplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].variableSpec* | object | Inherits: object |
| scatterplot.config.variables[].variableSpec.entityId* | string | |
| scatterplot.config.variables[].variableSpec.variableId* | string | |
| scatterplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].displayName | string | |
| scatterplot.config.variables[].displayRangeMin | any | |
| scatterplot.config.variables[].displayRangeMax | any | |
| scatterplot.config.variables[].vocabulary | array | |
| scatterplot.config.variables[].vocabulary[] | string | |
| scatterplot.config.variables[].isCollection* | boolean | |
| scatterplot.config.variables[].imputeZero* | boolean | |
| scatterplot.config.variables[].members | array | |
| scatterplot.config.variables[].members[] | object | Inherits: object |
| scatterplot.config.variables[].members[].entityId* | string | |
| scatterplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/betadiv/visualizations/scatterplot
Returns data required to create a scatterplot that explores the differences between samples in a dataset as described by beta diversity
Java impl- NA
R impl- NA
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/betadiv/visualizations/scatterplotRequest Body chevron_right expand_more
BetaDivScatterplotPostRequest BetaDivScatterplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.betaDivDissimilarityMethod* | string | Enum:
Inherits: lib.BetaDivDissimilarityMethod |
| config* | object | Inherits: lib.BetaDivScatterplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string |
200 OK chevron_right expand_more
ScatterplotPostResponse ScatterplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: lib.ScatterplotData |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.config* | object | Inherits: lib.PlotConfig |
| scatterplot.config.completeCasesAllVars* | number | |
| scatterplot.config.completeCasesAxesVars* | number | |
| scatterplot.config.variables* | array | |
| scatterplot.config.variables[] | object | Inherits: object |
| scatterplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].variableSpec* | object | Inherits: object |
| scatterplot.config.variables[].variableSpec.entityId* | string | |
| scatterplot.config.variables[].variableSpec.variableId* | string | |
| scatterplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].displayName | string | |
| scatterplot.config.variables[].displayRangeMin | any | |
| scatterplot.config.variables[].displayRangeMax | any | |
| scatterplot.config.variables[].vocabulary | array | |
| scatterplot.config.variables[].vocabulary[] | string | |
| scatterplot.config.variables[].isCollection* | boolean | |
| scatterplot.config.variables[].imputeZero* | boolean | |
| scatterplot.config.variables[].members | array | |
| scatterplot.config.variables[].members[] | object | Inherits: object |
| scatterplot.config.variables[].members[].entityId* | string | |
| scatterplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/differentialabundance/visualizations/volcanoplot
Returns data required to create a volcanoplot from a differential abundance analysis.
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/differentialabundance/visualizations/volcanoplotRequest Body chevron_right expand_more
DifferentialAbundanceVolcanoplotPostRequest DifferentialAbundanceVolcanoplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.comparator* | object | Additional properties: Yes Inherits: lib.ComparatorSpec |
| computeConfig.comparator.variable* | object | Inherits: object |
| computeConfig.comparator.variable.entityId* | string | |
| computeConfig.comparator.variable.variableId* | string | |
| computeConfig.comparator.groupA* | array | |
| computeConfig.comparator.groupA[] | string | |
| computeConfig.comparator.groupB* | array | |
| computeConfig.comparator.groupB[] | string | |
| computeConfig.differentialAbundanceMethod* | string | Enum:
Inherits: lib.DifferentialAbundanceMethod |
| config* | object | Inherits: lib.EmptyDataPluginSpec |
200 OK chevron_right expand_more
DifferentialAbundanceStatsResponse DifferentialAbundanceStatsResponse
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| log2foldChange* | array | |
| log2foldChange[] | string | |
| pValue* | array | |
| pValue[] | string | |
| adjustedPValue* | array | |
| adjustedPValue[] | string | |
| pointId* | array | |
| pointId[] | string |
post /apps/distributions/visualizations/histogram
Returns data required to create a histogram visualization.
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/distributions/visualizations/histogramRequest Body chevron_right expand_more
HistogramPostRequest HistogramPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.HistogramSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
HistogramPostResponse HistogramPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: lib.HistogramData |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.config* | object | Inherits: lib.PlotConfig |
| histogram.config.completeCasesAllVars* | number | |
| histogram.config.completeCasesAxesVars* | number | |
| histogram.config.variables* | array | |
| histogram.config.variables[] | object | Inherits: object |
| histogram.config.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.config.variables[].variableSpec* | object | Inherits: object |
| histogram.config.variables[].variableSpec.entityId* | string | |
| histogram.config.variables[].variableSpec.variableId* | string | |
| histogram.config.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.config.variables[].dataType* | string | Enum:
Inherits: string |
| histogram.config.variables[].dataShape* | string | Enum:
Inherits: string |
| histogram.config.variables[].displayName | string | |
| histogram.config.variables[].displayRangeMin | any | |
| histogram.config.variables[].displayRangeMax | any | |
| histogram.config.variables[].vocabulary | array | |
| histogram.config.variables[].vocabulary[] | string | |
| histogram.config.variables[].isCollection* | boolean | |
| histogram.config.variables[].imputeZero* | boolean | |
| histogram.config.variables[].members | array | |
| histogram.config.variables[].members[] | object | Inherits: object |
| histogram.config.variables[].members[].entityId* | string | |
| histogram.config.variables[].members[].variableId* | string | |
| histogram.config.binSlider* | object | Inherits: lib.BinSlider |
| histogram.config.binSlider.min* | number | |
| histogram.config.binSlider.max* | number | |
| histogram.config.binSlider.step* | number | |
| histogram.config.binSpec* | object | Inherits: lib.BinSpec |
| histogram.config.binSpec.type | string | Enum:
|
| histogram.config.binSpec.value | number | |
| histogram.config.binSpec.units | string | Enum:
Inherits: string |
| histogram.config.binSpec.range | union | |
| histogram.config.binSpec.range | anyOf | Any of the following types. |
| histogram.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| histogram.config.binSpec.range{NumberRange}..min* | number | |
| histogram.config.binSpec.range{NumberRange}..max* | number | |
| histogram.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| histogram.config.binSpec.range{DateRange}..min* | string | |
| histogram.config.binSpec.range{DateRange}..max* | string | |
| histogram.config.summary* | object | Additional properties: Yes Inherits: object |
| histogram.config.summary.min* | string | |
| histogram.config.summary.q1* | string | |
| histogram.config.summary.median* | string | |
| histogram.config.summary.mean* | string | |
| histogram.config.summary.q3* | string | |
| histogram.config.summary.max* | string | |
| histogram.config.viewport* | object | Inherits: lib.NumericViewport |
| histogram.config.viewport.xMin* | string | |
| histogram.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/distributions/visualizations/boxplot
Returns data required to create a boxplot visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/distributions/visualizations/boxplotRequest Body chevron_right expand_more
BoxplotPostRequest BoxplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BoxplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
200 OK chevron_right expand_more
BoxplotPostResponse BoxplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: lib.BoxplotData |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.config* | object | Inherits: lib.PlotConfig |
| boxplot.config.completeCasesAllVars* | number | |
| boxplot.config.completeCasesAxesVars* | number | |
| boxplot.config.variables* | array | |
| boxplot.config.variables[] | object | Inherits: object |
| boxplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.config.variables[].variableSpec* | object | Inherits: object |
| boxplot.config.variables[].variableSpec.entityId* | string | |
| boxplot.config.variables[].variableSpec.variableId* | string | |
| boxplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| boxplot.config.variables[].displayName | string | |
| boxplot.config.variables[].displayRangeMin | any | |
| boxplot.config.variables[].displayRangeMax | any | |
| boxplot.config.variables[].vocabulary | array | |
| boxplot.config.variables[].vocabulary[] | string | |
| boxplot.config.variables[].isCollection* | boolean | |
| boxplot.config.variables[].imputeZero* | boolean | |
| boxplot.config.variables[].members | array | |
| boxplot.config.variables[].members[] | object | Inherits: object |
| boxplot.config.variables[].members[].entityId* | string | |
| boxplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: lib.BoxplotStatsTable |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].xVariableDetails | object | Inherits: object |
| statsTable[].xVariableDetails.entityId* | string | |
| statsTable[].xVariableDetails.variableId* | string | |
| statsTable[].xVariableDetails.value* | string | |
| statsTable[].statistic* | string | |
| statsTable[].pvalue* | number | |
| statsTable[].parameter* | array | |
| statsTable[].parameter[] | number | |
| statsTable[].method* | string | |
| statsTable[].statsError* | string |
post /apps/countsandproportions/visualizations/barplot
Returns data required to create a bar or pie plot visualization
Java impl- drafted, not working
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/countsandproportions/visualizations/barplotRequest Body chevron_right expand_more
BarplotPostRequest BarplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BarplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
BarplotPostResponse BarplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: lib.BarplotData |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.config* | object | Inherits: lib.PlotConfig |
| barplot.config.completeCasesAllVars* | number | |
| barplot.config.completeCasesAxesVars* | number | |
| barplot.config.variables* | array | |
| barplot.config.variables[] | object | Inherits: object |
| barplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.config.variables[].variableSpec* | object | Inherits: object |
| barplot.config.variables[].variableSpec.entityId* | string | |
| barplot.config.variables[].variableSpec.variableId* | string | |
| barplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| barplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| barplot.config.variables[].displayName | string | |
| barplot.config.variables[].displayRangeMin | any | |
| barplot.config.variables[].displayRangeMax | any | |
| barplot.config.variables[].vocabulary | array | |
| barplot.config.variables[].vocabulary[] | string | |
| barplot.config.variables[].isCollection* | boolean | |
| barplot.config.variables[].imputeZero* | boolean | |
| barplot.config.variables[].members | array | |
| barplot.config.variables[].members[] | object | Inherits: object |
| barplot.config.variables[].members[].entityId* | string | |
| barplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/countsandproportions/visualizations/twobytwo
Returns data required to create a mosaic plot visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/countsandproportions/visualizations/twobytwoRequest Body chevron_right expand_more
TwoByTwoPostRequest TwoByTwoPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.xAxisReferenceValue* | string | |
| config.yAxisReferenceValue* | string |
200 OK chevron_right expand_more
TwoByTwoPostResponse TwoByTwoPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: object |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: string |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: object |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/countsandproportions/visualizations/conttable
Returns data required to create a mosaic plot visualization
Java impl- NA
R impl- drafted
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/countsandproportions/visualizations/conttableRequest Body chevron_right expand_more
MosaicPostRequest MosaicPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
200 OK chevron_right expand_more
ContTablePostResponse ContTablePostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: object |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: string |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: object |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].pvalue* | array | |
| statsTable[].pvalue[] | number | |
| statsTable[].degreesFreedom* | array | |
| statsTable[].degreesFreedom[] | number | |
| statsTable[].chisq* | array | |
| statsTable[].chisq[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/xyrelationships/visualizations/scatterplot
Returns data required to create a scatterplot visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/xyrelationships/visualizations/scatterplotRequest Body chevron_right expand_more
ScatterplotPostRequest ScatterplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ScatterplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
200 OK chevron_right expand_more
ScatterplotPostResponse ScatterplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: lib.ScatterplotData |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.config* | object | Inherits: lib.PlotConfig |
| scatterplot.config.completeCasesAllVars* | number | |
| scatterplot.config.completeCasesAxesVars* | number | |
| scatterplot.config.variables* | array | |
| scatterplot.config.variables[] | object | Inherits: object |
| scatterplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].variableSpec* | object | Inherits: object |
| scatterplot.config.variables[].variableSpec.entityId* | string | |
| scatterplot.config.variables[].variableSpec.variableId* | string | |
| scatterplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].displayName | string | |
| scatterplot.config.variables[].displayRangeMin | any | |
| scatterplot.config.variables[].displayRangeMax | any | |
| scatterplot.config.variables[].vocabulary | array | |
| scatterplot.config.variables[].vocabulary[] | string | |
| scatterplot.config.variables[].isCollection* | boolean | |
| scatterplot.config.variables[].imputeZero* | boolean | |
| scatterplot.config.variables[].members | array | |
| scatterplot.config.variables[].members[] | object | Inherits: object |
| scatterplot.config.variables[].members[].entityId* | string | |
| scatterplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/xyrelationships/visualizations/lineplot
Returns data required to create a lineplot visualization
Java impl- NA
R impl- working
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/xyrelationships/visualizations/lineplotRequest Body chevron_right expand_more
LineplotPostRequest LineplotPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.LineplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
200 OK chevron_right expand_more
LineplotPostResponse LineplotPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: lib.LineplotData |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.config* | object | Inherits: lib.PlotConfig |
| lineplot.config.completeCasesAllVars* | number | |
| lineplot.config.completeCasesAxesVars* | number | |
| lineplot.config.variables* | array | |
| lineplot.config.variables[] | object | Inherits: object |
| lineplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.config.variables[].variableSpec* | object | Inherits: object |
| lineplot.config.variables[].variableSpec.entityId* | string | |
| lineplot.config.variables[].variableSpec.variableId* | string | |
| lineplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| lineplot.config.variables[].displayName | string | |
| lineplot.config.variables[].displayRangeMin | any | |
| lineplot.config.variables[].displayRangeMax | any | |
| lineplot.config.variables[].vocabulary | array | |
| lineplot.config.variables[].vocabulary[] | string | |
| lineplot.config.variables[].isCollection* | boolean | |
| lineplot.config.variables[].imputeZero* | boolean | |
| lineplot.config.variables[].members | array | |
| lineplot.config.variables[].members[] | object | Inherits: object |
| lineplot.config.variables[].members[].entityId* | string | |
| lineplot.config.variables[].members[].variableId* | string | |
| lineplot.config.binSlider | object | Inherits: lib.BinSlider |
| lineplot.config.binSlider.min* | number | |
| lineplot.config.binSlider.max* | number | |
| lineplot.config.binSlider.step* | number | |
| lineplot.config.binSpec | object | Inherits: lib.BinSpec |
| lineplot.config.binSpec.type | string | Enum:
|
| lineplot.config.binSpec.value | number | |
| lineplot.config.binSpec.units | string | Enum:
Inherits: string |
| lineplot.config.binSpec.range | union | |
| lineplot.config.binSpec.range | anyOf | Any of the following types. |
| lineplot.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| lineplot.config.binSpec.range{NumberRange}..min* | number | |
| lineplot.config.binSpec.range{NumberRange}..max* | number | |
| lineplot.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| lineplot.config.binSpec.range{DateRange}..min* | string | |
| lineplot.config.binSpec.range{DateRange}..max* | string | |
| lineplot.config.viewport | object | Inherits: lib.NumericViewport |
| lineplot.config.viewport.xMin* | string | |
| lineplot.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
post /apps/sample/visualizations/record-count
Returns a count of the records in the subset
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/sample/visualizations/record-countRequest Body chevron_right expand_more
RecordCountPostRequest RecordCountPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.RecordCountSpec |
| config.entityId* | string |
200 OK chevron_right expand_more
RecordCountPostResponse RecordCountPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| recordCount* | integer |
post /apps/sample/visualizations/multi-stream
Returns a stream of records with its first two attributes (combined from parallel streams)
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/sample/visualizations/multi-streamRequest Body chevron_right expand_more
MultiStreamPostRequest MultiStreamPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MultiStreamSpec |
| config.entityId* | string |
200 OK chevron_right expand_more
EntityTabularPostResponse EntityTabularPostResponse
text/plain
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| counts* | array | |
| counts[] | array | |
| counts[][] | string |
post /apps/sample/visualizations/collections-test
Returns a tabular response for the subset with all vars in the requested collection
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/sample/visualizations/collections-testRequest Body chevron_right expand_more
TestCollectionsPostRequest TestCollectionsPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: object |
| config.entityId* | string | |
| config.collectionId* | string |
200 OK chevron_right expand_more
EntityTabularPostResponse EntityTabularPostResponse
text/plain
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| counts* | array | |
| counts[] | array | |
| counts[][] | string |
post /apps/sample/visualizations/categorical-distribution
Returns a set of count and proportion distributions for a native categorical variable
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/sample/visualizations/categorical-distributionRequest Body chevron_right expand_more
CategoricalDistributionPostRequest CategoricalDistributionPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: object |
| config.entityId* | string | |
| config.variableId* | string |
200 OK chevron_right expand_more
CategoricalDistributionPostResponse CategoricalDistributionPostResponse
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| countDistribution* | array | |
| countDistribution[] | object | Additional properties: Yes Inherits: object |
| countDistribution[].label* | string | |
| countDistribution[].value* | number | |
| proportionDistribution* | array | |
| proportionDistribution[] | object | Additional properties: Yes Inherits: object |
| proportionDistribution[].label* | string | |
| proportionDistribution[].value* | number |
post /apps/samplewithcompute/visualizations/viz-with-compute
Sample visualization plugin that uses data from a compute
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
undefined/apps/samplewithcompute/visualizations/viz-with-computeRequest Body chevron_right expand_more
ExampleComputeVizPostRequest ExampleComputeVizPostRequest
application/json
Inherits: lib.DataPluginRequestBase
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ExampleComputeVizSpec |
| config.prefixVar* | object | Inherits: object |
| config.prefixVar.entityId* | string | |
| config.prefixVar.variableId* | string | |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.inputVariable* | object | Inherits: object |
| computeConfig.inputVariable.entityId* | string | |
| computeConfig.inputVariable.variableId* | string | |
| computeConfig.valueSuffix* | string |
200 OK chevron_right expand_more
ExampleComputeVizPostResponse ExampleComputeVizPostResponse
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| countPluginResult* | integer | |
| numEmptyValues* | integer | |
| longestConcatenatedValue* | string | |
| avgConcatenatedLength* | number |
get /api
Renders the API documentation for this service.
curl -X GET \
undefined/api200 OK chevron_right expand_more
text/html
text/html
get /health
Prints information about the overall service health.
curl -X GET \
undefined/health200 OK chevron_right expand_more
HealthResponse HealthResponse
application/json
Health details about the service
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| status* | string | Status describes the overall service state. A status of "healthy" indicates that everything is running smoothly and all service dependencies are reachable and online. A status of "unhealthy" indicates that something is wrong with either this service or one or more of it's dependency services. Enum:
|
| dependencies* | array | A list of external services that this service depends on and some details about them. |
| dependencies[] | object | Inherits: DependencyStatus |
| dependencies[].name* | string | Name of the external depdendency. |
| dependencies[].reachable* | boolean | Whether or not the external service is reachable. |
| dependencies[].online* | string | Whether or not the external service is online and available for requests. Enum:
|
| info* | object | Additional properties: Yes |
| info.threads* | integer | Min. value: 1 |
| info.uptime* | string | |
| info.uptimeMillis* | integer | Min. value: 1 Format: int64 |
500 Internal Server Error chevron_right expand_more
Internal Server Error ServerError
application/json
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string | |
| requestId* | string |
Response Body
{
"status": "server-error",
"message": "Datastore connection lost",
"requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}get /metrics
Prometheus metrics for the service.
curl -X GET \
undefined/metrics200 OK chevron_right expand_more
text/plain
text/plain
Security Schemes
Security Scheme header-auth
header-auth
Authentication based on a WDK auth cookie.
Headers chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Auth_Key* | string | Authorization header. |
curl -X <method> \
-H "Auth_Key: <value>" \
/<path>Types
Type API_Filter (object)
API_Filter
Additional properties: Yes
Discriminator: type
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
Type API_FilterType (string)
API_FilterType
Enum:
- stringSet
- numberSet
- dateSet
- numberRange
- dateRange
- longitudeRange
- multiFilter
Inherits: string
Type API_BooleanOperationType (string)
API_BooleanOperationType
Enum:
- intersect
- union
Inherits: string
Type API_MultiFilterSubFilter (object)
API_MultiFilterSubFilter
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableId* | string | |
| stringSet* | array | |
| stringSet[] | string |
Type API_MultiFilter (object)
API_MultiFilter
Additional properties: Yes
Discriminator: type
Discriminator value: multiFilter
Inherits: lib.API_Filter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| operation* | string | Enum:
Inherits: string |
| variableId* | string | |
| subFilters* | array | |
| subFilters[] | object | Additional properties: Yes Inherits: object |
| subFilters[].variableId* | string | |
| subFilters[].stringSet* | array | |
| subFilters[].stringSet[] | string |
Type API_StringSetFilter (object)
API_StringSetFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| stringSet* | array | |
| stringSet[] | string |
Type API_NumberSetFilter (object)
API_NumberSetFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| numberSet* | array | |
| numberSet[] | number |
Type API_DateSetFilter (object)
API_DateSetFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| dateSet* | array | |
| dateSet[] | string |
Type API_NumberRangeFilter (object)
API_NumberRangeFilter
Additional properties: Yes
Discriminator: type
Discriminator value: numberRange
Inherits: lib.API_Filter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| min* | number | |
| max* | number |
Type API_DateRangeFilter (object)
API_DateRangeFilter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| min* | string | |
| max* | string |
Type API_LongitudeRangeFilter (object)
API_LongitudeRangeFilter
Additional properties: Yes
Discriminator: type
Discriminator value: longitudeRange
Inherits: lib.API_Filter
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| type* | string | Enum:
Inherits: lib.API_FilterType |
| variableId* | string | |
| left* | number | |
| right* | number |
Type VariableSpec (object)
VariableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| variableId* | string |
Type CollectionSpec (object)
CollectionSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| collectionId* | string |
Type DerivedVariableSpec (object)
DerivedVariableSpec
Inherits: lib.VariableSpec
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| variableId* | string | |
| expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| functionName* | string | |
| inputVars* | array | |
| inputVars[] | object | Inherits: object |
| inputVars[].entityId* | string | |
| inputVars[].variableId* | string | |
| config* | object |
Type EntityTabularPostResponse (object)
EntityTabularPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| counts* | array | |
| counts[] | array | |
| counts[][] | string |
Type API_PagingConfig (object)
API_PagingConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| numRows | integer | Format: int64 |
| offset | integer | Format: int64 |
Type BinUnits (string)
BinUnits
Enum:
- day
- week
- month
- year
Inherits: string
Type ValueSpec (string)
ValueSpec
Enum:
- count
- proportion
Inherits: string
Type API_VariableType (string)
API_VariableType
Enum:
- category
- string
- number
- date
- longitude
- integer
Inherits: string
Type API_VariableDataShape (string)
API_VariableDataShape
Enum:
- continuous
- categorical
- ordinal
- binary
Inherits: string
Type VariableClass (string)
VariableClass
Enum:
- native
- derived
- computed
Inherits: string
Type PlotReferenceValue (string)
PlotReferenceValue
Enum:
- xAxis
- yAxis
- zAxis
- overlay
- facet1
- facet2
- geo
- latitude
- longitude
Inherits: string
Type VariableMapping (object)
VariableMapping
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableClass* | string | Enum:
Inherits: string |
| variableSpec* | object | Inherits: object |
| variableSpec.entityId* | string | |
| variableSpec.variableId* | string | |
| plotReference* | string | Enum:
Inherits: string |
| dataType* | string | Enum:
Inherits: string |
| dataShape* | string | Enum:
Inherits: string |
| displayName | string | |
| displayRangeMin | any | |
| displayRangeMax | any | |
| vocabulary | array | |
| vocabulary[] | string | |
| isCollection* | boolean | |
| imputeZero* | boolean | |
| members | array | |
| members[] | object | Inherits: object |
| members[].entityId* | string | |
| members[].variableId* | string |
Type VisualizationDataElementConstraint (object)
VisualizationDataElementConstraint
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| isRequired* | boolean | |
| isTemporal* | boolean | |
| minNumVars* | number | |
| maxNumVars* | number | |
| minNumValues* | number | |
| maxNumValues* | number | |
| allowedTypes | array | |
| allowedTypes[] | string | Enum:
Inherits: string |
| allowedShapes | array | |
| allowedShapes[] | string | Enum:
Inherits: string |
| description* | string |
Type VisualizationDataElementConstraintPattern (object)
VisualizationDataElementConstraintPattern
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| //* | object | Inherits: object |
| //.isRequired* | boolean | |
| //.isTemporal* | boolean | |
| //.minNumVars* | number | |
| //.maxNumVars* | number | |
| //.minNumValues* | number | |
| //.maxNumValues* | number | |
| //.allowedTypes | array | |
| //.allowedTypes[] | string | Enum:
Inherits: string |
| //.allowedShapes | array | |
| //.allowedShapes[] | string | Enum:
Inherits: string |
| //.description* | string |
Type AlphaDivComputeConfig (object)
AlphaDivComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.variableId* | string | |
| alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
Type AlphaDivMethod (string)
AlphaDivMethod
Enum:
- shannon
- simpson
- evenness
Inherits: string
Type BetaDivComputeConfig (object)
BetaDivComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.variableId* | string | |
| betaDivDissimilarityMethod* | string | Enum:
Inherits: lib.BetaDivDissimilarityMethod |
Type BetaDivDissimilarityMethod (string)
BetaDivDissimilarityMethod
Enum:
- bray
- jaccard
- jsd
Inherits: string
Type DifferentialAbundanceComputeConfig (object)
DifferentialAbundanceComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.variableId* | string | |
| comparator* | object | Additional properties: Yes Inherits: lib.ComparatorSpec |
| comparator.variable* | object | Inherits: object |
| comparator.variable.entityId* | string | |
| comparator.variable.variableId* | string | |
| comparator.groupA* | array | |
| comparator.groupA[] | string | |
| comparator.groupB* | array | |
| comparator.groupB[] | string | |
| differentialAbundanceMethod* | string | Enum:
Inherits: lib.DifferentialAbundanceMethod |
Type DifferentialAbundanceMethod (string)
DifferentialAbundanceMethod
Enum:
- DESeq
- ANCOMBC
Inherits: string
Type ComparatorSpec (object)
ComparatorSpec
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variable* | object | Inherits: object |
| variable.entityId* | string | |
| variable.variableId* | string | |
| groupA* | array | |
| groupA[] | string | |
| groupB* | array | |
| groupB[] | string |
Type DifferentialAbundanceStatsResponse (object)
DifferentialAbundanceStatsResponse
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| log2foldChange* | array | |
| log2foldChange[] | string | |
| pValue* | array | |
| pValue[] | string | |
| adjustedPValue* | array | |
| adjustedPValue[] | string | |
| pointId* | array | |
| pointId[] | string |
Type ExampleComputeConfig (object)
ExampleComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| inputVariable* | object | Inherits: object |
| inputVariable.entityId* | string | |
| inputVariable.variableId* | string | |
| valueSuffix* | string |
Type RankedAbundanceComputeConfig (object)
RankedAbundanceComputeConfig
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collectionVariable* | object | Inherits: object |
| collectionVariable.entityId* | string | |
| collectionVariable.variableId* | string | |
| rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
Type RankingMethod (string)
RankingMethod
Enum:
- median
- q3
- variance
- max
Inherits: string
Type AbundanceBoxplotPostRequest (object)
AbundanceBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
| config* | object | Inherits: lib.BoxplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AbundanceScatterplotPostRequest (object)
AbundanceScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.rankingMethod* | string | Enum:
Inherits: lib.RankingMethod |
| config* | object | Inherits: lib.ScatterplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AlphaDivBoxplotPostRequest (object)
AlphaDivBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
| config* | object | Inherits: lib.BoxplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AlphaDivScatterplotPostRequest (object)
AlphaDivScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.alphaDivMethod* | string | Enum:
Inherits: lib.AlphaDivMethod |
| config* | object | Inherits: lib.ScatterplotWith1ComputeSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type AppsGetResponse (object)
AppsGetResponse
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| apps* | array | |
| apps[] | object | Inherits: lib.AppOverview |
| apps[].name* | string | |
| apps[].displayName* | string | |
| apps[].description* | string | |
| apps[].projects* | array | |
| apps[].projects[] | string | |
| apps[].computeName | string | |
| apps[].visualizations* | array | |
| apps[].visualizations[] | object | Inherits: lib.VisualizationOverview |
| apps[].visualizations[].name* | string | |
| apps[].visualizations[].displayName* | string | |
| apps[].visualizations[].description* | string | |
| apps[].visualizations[].projects* | array | |
| apps[].visualizations[].projects[] | string | |
| apps[].visualizations[].maxPanels* | number | |
| apps[].visualizations[].dataElementConstraints | array | |
| apps[].visualizations[].dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| apps[].visualizations[].dataElementConstraints[].//* | object | Inherits: object |
| apps[].visualizations[].dataElementConstraints[].//.isRequired* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.isTemporal* | boolean | |
| apps[].visualizations[].dataElementConstraints[].//.minNumVars* | number | |
| apps[].visualizations[].dataElementConstraints[].//.maxNumVars* | number | |
| apps[].visualizations[].dataElementConstraints[].//.minNumValues* | number | |
| apps[].visualizations[].dataElementConstraints[].//.maxNumValues* | number | |
| apps[].visualizations[].dataElementConstraints[].//.allowedTypes | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: string |
| apps[].visualizations[].dataElementConstraints[].//.allowedShapes | array | |
| apps[].visualizations[].dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: string |
| apps[].visualizations[].dataElementConstraints[].//.description* | string | |
| apps[].visualizations[].dataElementDependencyOrder | array | |
| apps[].visualizations[].dataElementDependencyOrder[] | array | |
| apps[].visualizations[].dataElementDependencyOrder[][] | string |
Type AppOverview (object)
AppOverview
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| displayName* | string | |
| description* | string | |
| projects* | array | |
| projects[] | string | |
| computeName | string | |
| visualizations* | array | |
| visualizations[] | object | Inherits: lib.VisualizationOverview |
| visualizations[].name* | string | |
| visualizations[].displayName* | string | |
| visualizations[].description* | string | |
| visualizations[].projects* | array | |
| visualizations[].projects[] | string | |
| visualizations[].maxPanels* | number | |
| visualizations[].dataElementConstraints | array | |
| visualizations[].dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| visualizations[].dataElementConstraints[].//* | object | Inherits: object |
| visualizations[].dataElementConstraints[].//.isRequired* | boolean | |
| visualizations[].dataElementConstraints[].//.isTemporal* | boolean | |
| visualizations[].dataElementConstraints[].//.minNumVars* | number | |
| visualizations[].dataElementConstraints[].//.maxNumVars* | number | |
| visualizations[].dataElementConstraints[].//.minNumValues* | number | |
| visualizations[].dataElementConstraints[].//.maxNumValues* | number | |
| visualizations[].dataElementConstraints[].//.allowedTypes | array | |
| visualizations[].dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: string |
| visualizations[].dataElementConstraints[].//.allowedShapes | array | |
| visualizations[].dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: string |
| visualizations[].dataElementConstraints[].//.description* | string | |
| visualizations[].dataElementDependencyOrder | array | |
| visualizations[].dataElementDependencyOrder[] | array | |
| visualizations[].dataElementDependencyOrder[][] | string |
Type VisualizationOverview (object)
VisualizationOverview
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| displayName* | string | |
| description* | string | |
| projects* | array | |
| projects[] | string | |
| maxPanels* | number | |
| dataElementConstraints | array | |
| dataElementConstraints[] | object | Additional properties: Yes Inherits: object |
| dataElementConstraints[].//* | object | Inherits: object |
| dataElementConstraints[].//.isRequired* | boolean | |
| dataElementConstraints[].//.isTemporal* | boolean | |
| dataElementConstraints[].//.minNumVars* | number | |
| dataElementConstraints[].//.maxNumVars* | number | |
| dataElementConstraints[].//.minNumValues* | number | |
| dataElementConstraints[].//.maxNumValues* | number | |
| dataElementConstraints[].//.allowedTypes | array | |
| dataElementConstraints[].//.allowedTypes[] | string | Enum:
Inherits: string |
| dataElementConstraints[].//.allowedShapes | array | |
| dataElementConstraints[].//.allowedShapes[] | string | Enum:
Inherits: string |
| dataElementConstraints[].//.description* | string | |
| dataElementDependencyOrder | array | |
| dataElementDependencyOrder[] | array | |
| dataElementDependencyOrder[][] | string |
Type BetaDivScatterplotPostRequest (object)
BetaDivScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.betaDivDissimilarityMethod* | string | Enum:
Inherits: lib.BetaDivDissimilarityMethod |
| config* | object | Inherits: lib.BetaDivScatterplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string |
Type BetaDivScatterplotSpec (object)
BetaDivScatterplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string |
Type DifferentialAbundanceVolcanoplotPostRequest (object)
DifferentialAbundanceVolcanoplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.collectionVariable* | object | Inherits: object |
| computeConfig.collectionVariable.entityId* | string | |
| computeConfig.collectionVariable.variableId* | string | |
| computeConfig.comparator* | object | Additional properties: Yes Inherits: lib.ComparatorSpec |
| computeConfig.comparator.variable* | object | Inherits: object |
| computeConfig.comparator.variable.entityId* | string | |
| computeConfig.comparator.variable.variableId* | string | |
| computeConfig.comparator.groupA* | array | |
| computeConfig.comparator.groupA[] | string | |
| computeConfig.comparator.groupB* | array | |
| computeConfig.comparator.groupB[] | string | |
| computeConfig.differentialAbundanceMethod* | string | Enum:
Inherits: lib.DifferentialAbundanceMethod |
| config* | object | Inherits: lib.EmptyDataPluginSpec |
Type ContinuousVariableMetadataPostRequest (object)
ContinuousVariableMetadataPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ContinuousVariableMetadataSpec |
| config.variable* | object | Inherits: object |
| config.variable.entityId* | string | |
| config.variable.variableId* | string | |
| config.metadata* | array | |
| config.metadata[] | string | Enum:
|
Type ContinuousVariableMetadataSpec (object)
ContinuousVariableMetadataSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variable* | object | Inherits: object |
| variable.entityId* | string | |
| variable.variableId* | string | |
| metadata* | array | |
| metadata[] | string | Enum:
|
Type BinRange (object)
BinRange
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| binStart* | string | |
| binEnd* | string | |
| binLabel* | string |
Type BinRangeWithValue (object)
BinRangeWithValue
Inherits: lib.BinRange
Model
| Parameter | Type | Description |
|---|---|---|
| binStart* | string | |
| binEnd* | string | |
| binLabel* | string | |
| value* | number |
Type AllBinRanges (object)
AllBinRanges
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| equalInterval* | array | |
| equalInterval[] | object | Inherits: object |
| equalInterval[].binStart* | string | |
| equalInterval[].binEnd* | string | |
| equalInterval[].binLabel* | string | |
| quantile* | array | |
| quantile[] | object | Inherits: object |
| quantile[].binStart* | string | |
| quantile[].binEnd* | string | |
| quantile[].binLabel* | string | |
| standardDeviation* | array | |
| standardDeviation[] | object | Inherits: object |
| standardDeviation[].binStart* | string | |
| standardDeviation[].binEnd* | string | |
| standardDeviation[].binLabel* | string |
Type ContinuousVariableMetadataPostResponse (object)
ContinuousVariableMetadataPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| binRanges | object | Inherits: object |
| binRanges.equalInterval* | array | |
| binRanges.equalInterval[] | object | Inherits: object |
| binRanges.equalInterval[].binStart* | string | |
| binRanges.equalInterval[].binEnd* | string | |
| binRanges.equalInterval[].binLabel* | string | |
| binRanges.quantile* | array | |
| binRanges.quantile[] | object | Inherits: object |
| binRanges.quantile[].binStart* | string | |
| binRanges.quantile[].binEnd* | string | |
| binRanges.quantile[].binLabel* | string | |
| binRanges.standardDeviation* | array | |
| binRanges.standardDeviation[] | object | Inherits: object |
| binRanges.standardDeviation[].binStart* | string | |
| binRanges.standardDeviation[].binEnd* | string | |
| binRanges.standardDeviation[].binLabel* | string | |
| median | number |
Type BarplotPostRequest (object)
BarplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BarplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type BarplotSpec (object)
BarplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Barplot (object)
Barplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.BarplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: object |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: string |
| config.variables[].dataShape* | string | Enum:
Inherits: string |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].isCollection* | boolean | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: object |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type BarplotPostResponse (object)
BarplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: lib.BarplotData |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.config* | object | Inherits: lib.PlotConfig |
| barplot.config.completeCasesAllVars* | number | |
| barplot.config.completeCasesAxesVars* | number | |
| barplot.config.variables* | array | |
| barplot.config.variables[] | object | Inherits: object |
| barplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.config.variables[].variableSpec* | object | Inherits: object |
| barplot.config.variables[].variableSpec.entityId* | string | |
| barplot.config.variables[].variableSpec.variableId* | string | |
| barplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| barplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| barplot.config.variables[].displayName | string | |
| barplot.config.variables[].displayRangeMin | any | |
| barplot.config.variables[].displayRangeMax | any | |
| barplot.config.variables[].vocabulary | array | |
| barplot.config.variables[].vocabulary[] | string | |
| barplot.config.variables[].isCollection* | boolean | |
| barplot.config.variables[].imputeZero* | boolean | |
| barplot.config.variables[].members | array | |
| barplot.config.variables[].members[] | object | Inherits: object |
| barplot.config.variables[].members[].entityId* | string | |
| barplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type BoxplotPostRequest (object)
BoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.BoxplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.points* | string | Enum:
|
| config.mean* | string | Enum:
Inherits: lib.StringBoolean |
| config.computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type BoxplotSpec (object)
BoxplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| points* | string | Enum:
|
| mean* | string | Enum:
Inherits: lib.StringBoolean |
| computeStats* | string | Enum:
Inherits: lib.StringBoolean |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type Boxplot (object)
Boxplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.BoxplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].lowerfence* | array | |
| data[].lowerfence[] | number | |
| data[].upperfence* | array | |
| data[].upperfence[] | number | |
| data[].q1* | array | |
| data[].q1[] | number | |
| data[].q3* | array | |
| data[].q3[] | number | |
| data[].median* | array | |
| data[].median[] | number | |
| data[].outliers | array | |
| data[].outliers[] | array | |
| data[].outliers[][] | number | |
| data[].rawData | array | |
| data[].rawData[] | array | |
| data[].rawData[][] | number | |
| data[].mean | array | |
| data[].mean[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: object |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: string |
| config.variables[].dataShape* | string | Enum:
Inherits: string |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].isCollection* | boolean | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: object |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type BoxplotPostResponse (object)
BoxplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: lib.BoxplotData |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.config* | object | Inherits: lib.PlotConfig |
| boxplot.config.completeCasesAllVars* | number | |
| boxplot.config.completeCasesAxesVars* | number | |
| boxplot.config.variables* | array | |
| boxplot.config.variables[] | object | Inherits: object |
| boxplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.config.variables[].variableSpec* | object | Inherits: object |
| boxplot.config.variables[].variableSpec.entityId* | string | |
| boxplot.config.variables[].variableSpec.variableId* | string | |
| boxplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| boxplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| boxplot.config.variables[].displayName | string | |
| boxplot.config.variables[].displayRangeMin | any | |
| boxplot.config.variables[].displayRangeMax | any | |
| boxplot.config.variables[].vocabulary | array | |
| boxplot.config.variables[].vocabulary[] | string | |
| boxplot.config.variables[].isCollection* | boolean | |
| boxplot.config.variables[].imputeZero* | boolean | |
| boxplot.config.variables[].members | array | |
| boxplot.config.variables[].members[] | object | Inherits: object |
| boxplot.config.variables[].members[].entityId* | string | |
| boxplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: lib.BoxplotStatsTable |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].xVariableDetails | object | Inherits: object |
| statsTable[].xVariableDetails.entityId* | string | |
| statsTable[].xVariableDetails.variableId* | string | |
| statsTable[].xVariableDetails.value* | string | |
| statsTable[].statistic* | string | |
| statsTable[].pvalue* | number | |
| statsTable[].parameter* | array | |
| statsTable[].parameter[] | number | |
| statsTable[].method* | string | |
| statsTable[].statsError* | string |
Type ContTableStatsTable (object)
ContTableStatsTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| pvalue* | array | |
| pvalue[] | number | |
| degreesFreedom* | array | |
| degreesFreedom[] | number | |
| chisq* | array | |
| chisq[] | number |
Type ContTablePostResponse (object)
ContTablePostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: object |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: string |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: object |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].pvalue* | array | |
| statsTable[].pvalue[] | number | |
| statsTable[].degreesFreedom* | array | |
| statsTable[].degreesFreedom[] | number | |
| statsTable[].chisq* | array | |
| statsTable[].chisq[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type DensityplotPostRequest (object)
DensityplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.DensityplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type DensityplotSpec (object)
DensityplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Densityplot (object)
Densityplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.DensityplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].densityY* | array | |
| data[].densityY[] | number | |
| data[].densityX* | array | |
| data[].densityX[] | number | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: object |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: string |
| config.variables[].dataShape* | string | Enum:
Inherits: string |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].isCollection* | boolean | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: object |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type DensityplotPostResponse (object)
DensityplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| densityplot* | object | Inherits: object |
| densityplot.data* | array | |
| densityplot.data[] | object | Inherits: lib.DensityplotData |
| densityplot.data[].overlayVariableDetails | object | Inherits: object |
| densityplot.data[].overlayVariableDetails.entityId* | string | |
| densityplot.data[].overlayVariableDetails.variableId* | string | |
| densityplot.data[].overlayVariableDetails.value* | string | |
| densityplot.data[].facetVariableDetails | array | Max. items: 2 |
| densityplot.data[].facetVariableDetails[] | object | Inherits: object |
| densityplot.data[].facetVariableDetails[].entityId* | string | |
| densityplot.data[].facetVariableDetails[].variableId* | string | |
| densityplot.data[].facetVariableDetails[].value* | string | |
| densityplot.data[].densityY* | array | |
| densityplot.data[].densityY[] | number | |
| densityplot.data[].densityX* | array | |
| densityplot.data[].densityX[] | number | |
| densityplot.config* | object | Inherits: lib.PlotConfig |
| densityplot.config.completeCasesAllVars* | number | |
| densityplot.config.completeCasesAxesVars* | number | |
| densityplot.config.variables* | array | |
| densityplot.config.variables[] | object | Inherits: object |
| densityplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| densityplot.config.variables[].variableSpec* | object | Inherits: object |
| densityplot.config.variables[].variableSpec.entityId* | string | |
| densityplot.config.variables[].variableSpec.variableId* | string | |
| densityplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| densityplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| densityplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| densityplot.config.variables[].displayName | string | |
| densityplot.config.variables[].displayRangeMin | any | |
| densityplot.config.variables[].displayRangeMax | any | |
| densityplot.config.variables[].vocabulary | array | |
| densityplot.config.variables[].vocabulary[] | string | |
| densityplot.config.variables[].isCollection* | boolean | |
| densityplot.config.variables[].imputeZero* | boolean | |
| densityplot.config.variables[].members | array | |
| densityplot.config.variables[].members[] | object | Inherits: object |
| densityplot.config.variables[].members[].entityId* | string | |
| densityplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type HeatmapPostRequest (object)
HeatmapPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.HeatmapSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.zAxisVariable | object | Inherits: object |
| config.zAxisVariable.entityId* | string | |
| config.zAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type HeatmapSpec (object)
HeatmapSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| zAxisVariable | object | Inherits: object |
| zAxisVariable.entityId* | string | |
| zAxisVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Heatmap (object)
Heatmap
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.HeatmapData |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | array | |
| data[].value[][] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: object |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: string |
| config.variables[].dataShape* | string | Enum:
Inherits: string |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].isCollection* | boolean | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: object |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type HeatmapPostResponse (object)
HeatmapPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| heatmap* | object | Inherits: object |
| heatmap.data* | array | |
| heatmap.data[] | object | Inherits: lib.HeatmapData |
| heatmap.data[].facetVariableDetails | array | Max. items: 2 |
| heatmap.data[].facetVariableDetails[] | object | Inherits: object |
| heatmap.data[].facetVariableDetails[].entityId* | string | |
| heatmap.data[].facetVariableDetails[].variableId* | string | |
| heatmap.data[].facetVariableDetails[].value* | string | |
| heatmap.data[].value* | array | |
| heatmap.data[].value[] | array | |
| heatmap.data[].value[][] | number | |
| heatmap.data[].label* | array | |
| heatmap.data[].label[] | string | |
| heatmap.config* | object | Inherits: lib.PlotConfig |
| heatmap.config.completeCasesAllVars* | number | |
| heatmap.config.completeCasesAxesVars* | number | |
| heatmap.config.variables* | array | |
| heatmap.config.variables[] | object | Inherits: object |
| heatmap.config.variables[].variableClass* | string | Enum:
Inherits: string |
| heatmap.config.variables[].variableSpec* | object | Inherits: object |
| heatmap.config.variables[].variableSpec.entityId* | string | |
| heatmap.config.variables[].variableSpec.variableId* | string | |
| heatmap.config.variables[].plotReference* | string | Enum:
Inherits: string |
| heatmap.config.variables[].dataType* | string | Enum:
Inherits: string |
| heatmap.config.variables[].dataShape* | string | Enum:
Inherits: string |
| heatmap.config.variables[].displayName | string | |
| heatmap.config.variables[].displayRangeMin | any | |
| heatmap.config.variables[].displayRangeMax | any | |
| heatmap.config.variables[].vocabulary | array | |
| heatmap.config.variables[].vocabulary[] | string | |
| heatmap.config.variables[].isCollection* | boolean | |
| heatmap.config.variables[].imputeZero* | boolean | |
| heatmap.config.variables[].members | array | |
| heatmap.config.variables[].members[] | object | Inherits: object |
| heatmap.config.variables[].members[].entityId* | string | |
| heatmap.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type HistogramPostRequest (object)
HistogramPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.HistogramSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type HistogramSpec (object)
HistogramSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type HistogramSummary (object)
HistogramSummary
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| q1* | string | |
| median* | string | |
| mean* | string | |
| q3* | string | |
| max* | string |
Type HistogramConfig (object)
HistogramConfig
Inherits: lib.PlotConfig
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| binSlider* | object | Inherits: lib.BinSlider |
| binSlider.min* | number | |
| binSlider.max* | number | |
| binSlider.step* | number | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| summary* | object | Additional properties: Yes Inherits: object |
| summary.min* | string | |
| summary.q1* | string | |
| summary.median* | string | |
| summary.mean* | string | |
| summary.q3* | string | |
| summary.max* | string | |
| viewport* | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type Histogram (object)
Histogram
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.HistogramData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].binStart* | array | |
| data[].binStart[] | string | |
| data[].binEnd* | array | |
| data[].binEnd[] | string | |
| data[].binLabel* | array | |
| data[].binLabel[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: object |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: string |
| config.variables[].dataShape* | string | Enum:
Inherits: string |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].isCollection* | boolean | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: object |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.binSlider* | object | Inherits: lib.BinSlider |
| config.binSlider.min* | number | |
| config.binSlider.max* | number | |
| config.binSlider.step* | number | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.summary* | object | Additional properties: Yes Inherits: object |
| config.summary.min* | string | |
| config.summary.q1* | string | |
| config.summary.median* | string | |
| config.summary.mean* | string | |
| config.summary.q3* | string | |
| config.summary.max* | string | |
| config.viewport* | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type HistogramPostResponse (object)
HistogramPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: lib.HistogramData |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.config* | object | Inherits: lib.PlotConfig |
| histogram.config.completeCasesAllVars* | number | |
| histogram.config.completeCasesAxesVars* | number | |
| histogram.config.variables* | array | |
| histogram.config.variables[] | object | Inherits: object |
| histogram.config.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.config.variables[].variableSpec* | object | Inherits: object |
| histogram.config.variables[].variableSpec.entityId* | string | |
| histogram.config.variables[].variableSpec.variableId* | string | |
| histogram.config.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.config.variables[].dataType* | string | Enum:
Inherits: string |
| histogram.config.variables[].dataShape* | string | Enum:
Inherits: string |
| histogram.config.variables[].displayName | string | |
| histogram.config.variables[].displayRangeMin | any | |
| histogram.config.variables[].displayRangeMax | any | |
| histogram.config.variables[].vocabulary | array | |
| histogram.config.variables[].vocabulary[] | string | |
| histogram.config.variables[].isCollection* | boolean | |
| histogram.config.variables[].imputeZero* | boolean | |
| histogram.config.variables[].members | array | |
| histogram.config.variables[].members[] | object | Inherits: object |
| histogram.config.variables[].members[].entityId* | string | |
| histogram.config.variables[].members[].variableId* | string | |
| histogram.config.binSlider* | object | Inherits: lib.BinSlider |
| histogram.config.binSlider.min* | number | |
| histogram.config.binSlider.max* | number | |
| histogram.config.binSlider.step* | number | |
| histogram.config.binSpec* | object | Inherits: lib.BinSpec |
| histogram.config.binSpec.type | string | Enum:
|
| histogram.config.binSpec.value | number | |
| histogram.config.binSpec.units | string | Enum:
Inherits: string |
| histogram.config.binSpec.range | union | |
| histogram.config.binSpec.range | anyOf | Any of the following types. |
| histogram.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| histogram.config.binSpec.range{NumberRange}..min* | number | |
| histogram.config.binSpec.range{NumberRange}..max* | number | |
| histogram.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| histogram.config.binSpec.range{DateRange}..min* | string | |
| histogram.config.binSpec.range{DateRange}..max* | string | |
| histogram.config.summary* | object | Additional properties: Yes Inherits: object |
| histogram.config.summary.min* | string | |
| histogram.config.summary.q1* | string | |
| histogram.config.summary.median* | string | |
| histogram.config.summary.mean* | string | |
| histogram.config.summary.q3* | string | |
| histogram.config.summary.max* | string | |
| histogram.config.viewport* | object | Inherits: lib.NumericViewport |
| histogram.config.viewport.xMin* | string | |
| histogram.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type LineplotPostRequest (object)
LineplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.LineplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type LineplotSpec (object)
LineplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| yAxisNumeratorValues | array | |
| yAxisNumeratorValues[] | string | |
| yAxisDenominatorValues | array | |
| yAxisDenominatorValues[] | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| valueSpec* | string | Enum:
|
| errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type LineplotConfig (object)
LineplotConfig
Inherits: lib.PlotConfig
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| binSlider | object | Inherits: lib.BinSlider |
| binSlider.min* | number | |
| binSlider.max* | number | |
| binSlider.step* | number | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type Lineplot (object)
Lineplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.LineplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].binStart | array | |
| data[].binStart[] | string | |
| data[].binEnd | array | |
| data[].binEnd[] | string | |
| data[].binSampleSize | array | |
| data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| data[].binSampleSize[] | anyOf | Any of the following types. |
| data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| data[].errorBars | array | |
| data[].errorBars[] | object | Inherits: lib.ErrorBar |
| data[].errorBars[].lowerBound* | number | |
| data[].errorBars[].upperBound* | number | |
| data[].errorBars[].error* | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: object |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: string |
| config.variables[].dataShape* | string | Enum:
Inherits: string |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].isCollection* | boolean | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: object |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.binSlider | object | Inherits: lib.BinSlider |
| config.binSlider.min* | number | |
| config.binSlider.max* | number | |
| config.binSlider.step* | number | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type LineplotPostResponse (object)
LineplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: lib.LineplotData |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.config* | object | Inherits: lib.PlotConfig |
| lineplot.config.completeCasesAllVars* | number | |
| lineplot.config.completeCasesAxesVars* | number | |
| lineplot.config.variables* | array | |
| lineplot.config.variables[] | object | Inherits: object |
| lineplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.config.variables[].variableSpec* | object | Inherits: object |
| lineplot.config.variables[].variableSpec.entityId* | string | |
| lineplot.config.variables[].variableSpec.variableId* | string | |
| lineplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| lineplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| lineplot.config.variables[].displayName | string | |
| lineplot.config.variables[].displayRangeMin | any | |
| lineplot.config.variables[].displayRangeMax | any | |
| lineplot.config.variables[].vocabulary | array | |
| lineplot.config.variables[].vocabulary[] | string | |
| lineplot.config.variables[].isCollection* | boolean | |
| lineplot.config.variables[].imputeZero* | boolean | |
| lineplot.config.variables[].members | array | |
| lineplot.config.variables[].members[] | object | Inherits: object |
| lineplot.config.variables[].members[].entityId* | string | |
| lineplot.config.variables[].members[].variableId* | string | |
| lineplot.config.binSlider | object | Inherits: lib.BinSlider |
| lineplot.config.binSlider.min* | number | |
| lineplot.config.binSlider.max* | number | |
| lineplot.config.binSlider.step* | number | |
| lineplot.config.binSpec | object | Inherits: lib.BinSpec |
| lineplot.config.binSpec.type | string | Enum:
|
| lineplot.config.binSpec.value | number | |
| lineplot.config.binSpec.units | string | Enum:
Inherits: string |
| lineplot.config.binSpec.range | union | |
| lineplot.config.binSpec.range | anyOf | Any of the following types. |
| lineplot.config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| lineplot.config.binSpec.range{NumberRange}..min* | number | |
| lineplot.config.binSpec.range{NumberRange}..max* | number | |
| lineplot.config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| lineplot.config.binSpec.range{DateRange}..min* | string | |
| lineplot.config.binSpec.range{DateRange}..max* | string | |
| lineplot.config.viewport | object | Inherits: lib.NumericViewport |
| lineplot.config.viewport.xMin* | string | |
| lineplot.config.viewport.xMax* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type MapMarkersOverlayPostRequest (object)
MapMarkersOverlayPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MapMarkersOverlaySpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingness |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.longitudeVariable | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type MapMarkersOverlaySpec (object)
MapMarkersOverlaySpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingness |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| valueSpec* | string | Enum:
Inherits: string |
| longitudeVariable | object | Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable | object | Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| viewport | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type MapMarkersOverlayConfig (object)
MapMarkersOverlayConfig
Inherits: lib.PlotConfig
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string | |
| viewport* | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type MapMarkersOverlay (object)
MapMarkersOverlay
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.MapMarkersOverlayData |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: object |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: string |
| config.variables[].dataShape* | string | Enum:
Inherits: string |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].isCollection* | boolean | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: object |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string | |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type MapMarkersOverlayPostResponse (object)
MapMarkersOverlayPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapMarkers* | object | Inherits: object |
| mapMarkers.data* | array | |
| mapMarkers.data[] | object | Inherits: lib.MapMarkersOverlayData |
| mapMarkers.data[].facetVariableDetails | array | Max. items: 2 |
| mapMarkers.data[].facetVariableDetails[] | object | Inherits: object |
| mapMarkers.data[].facetVariableDetails[].entityId* | string | |
| mapMarkers.data[].facetVariableDetails[].variableId* | string | |
| mapMarkers.data[].facetVariableDetails[].value* | string | |
| mapMarkers.data[].value* | array | |
| mapMarkers.data[].value[] | number | |
| mapMarkers.data[].label* | array | |
| mapMarkers.data[].label[] | string | |
| mapMarkers.config* | object | Inherits: lib.PlotConfig |
| mapMarkers.config.completeCasesAllVars* | number | |
| mapMarkers.config.completeCasesAxesVars* | number | |
| mapMarkers.config.variables* | array | |
| mapMarkers.config.variables[] | object | Inherits: object |
| mapMarkers.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].variableSpec* | object | Inherits: object |
| mapMarkers.config.variables[].variableSpec.entityId* | string | |
| mapMarkers.config.variables[].variableSpec.variableId* | string | |
| mapMarkers.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].dataType* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].dataShape* | string | Enum:
Inherits: string |
| mapMarkers.config.variables[].displayName | string | |
| mapMarkers.config.variables[].displayRangeMin | any | |
| mapMarkers.config.variables[].displayRangeMax | any | |
| mapMarkers.config.variables[].vocabulary | array | |
| mapMarkers.config.variables[].vocabulary[] | string | |
| mapMarkers.config.variables[].isCollection* | boolean | |
| mapMarkers.config.variables[].imputeZero* | boolean | |
| mapMarkers.config.variables[].members | array | |
| mapMarkers.config.variables[].members[] | object | Inherits: object |
| mapMarkers.config.variables[].members[].entityId* | string | |
| mapMarkers.config.variables[].members[].variableId* | string | |
| mapMarkers.config.viewport* | object | Inherits: lib.GeolocationViewport |
| mapMarkers.config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| mapMarkers.config.viewport.latitude.xMin* | string | |
| mapMarkers.config.viewport.latitude.xMax* | string | |
| mapMarkers.config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| mapMarkers.config.viewport.longitude.left* | number | |
| mapMarkers.config.viewport.longitude.right* | number | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type MapPostRequest (object)
MapPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MapSpec |
| config.outputEntityId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type MapSpec (object)
MapSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| viewport* | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type MapConfig (object)
MapConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesGeoVar* | number |
Type MapPostResponse (object)
MapPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.MapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number | |
| config* | object | Inherits: object |
| config.completeCasesGeoVar* | number |
Type MapElementInfo (object)
MapElementInfo
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateValue* | string | |
| entityCount* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number |
Type ScatterplotPostRequest (object)
ScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ScatterplotSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayVariable | object | Inherits: object |
| config.overlayVariable.entityId* | string | |
| config.overlayVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type ScatterplotSpec (object)
ScatterplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type Scatterplot (object)
Scatterplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: lib.ScatterplotData |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].smoothedMeanX | array | |
| data[].smoothedMeanX[] | string | |
| data[].smoothedMeanY | array | |
| data[].smoothedMeanY[] | number | |
| data[].smoothedMeanSE | array | |
| data[].smoothedMeanSE[] | number | |
| data[].smoothedMeanError | string | |
| data[].bestFitLineX | array | |
| data[].bestFitLineX[] | string | |
| data[].bestFitLineY | array | |
| data[].bestFitLineY[] | number | |
| data[].r2 | number | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: object |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: string |
| config.variables[].dataShape* | string | Enum:
Inherits: string |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].isCollection* | boolean | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: object |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type ScatterplotPostResponse (object)
ScatterplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: lib.ScatterplotData |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.config* | object | Inherits: lib.PlotConfig |
| scatterplot.config.completeCasesAllVars* | number | |
| scatterplot.config.completeCasesAxesVars* | number | |
| scatterplot.config.variables* | array | |
| scatterplot.config.variables[] | object | Inherits: object |
| scatterplot.config.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].variableSpec* | object | Inherits: object |
| scatterplot.config.variables[].variableSpec.entityId* | string | |
| scatterplot.config.variables[].variableSpec.variableId* | string | |
| scatterplot.config.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataType* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].dataShape* | string | Enum:
Inherits: string |
| scatterplot.config.variables[].displayName | string | |
| scatterplot.config.variables[].displayRangeMin | any | |
| scatterplot.config.variables[].displayRangeMax | any | |
| scatterplot.config.variables[].vocabulary | array | |
| scatterplot.config.variables[].vocabulary[] | string | |
| scatterplot.config.variables[].isCollection* | boolean | |
| scatterplot.config.variables[].imputeZero* | boolean | |
| scatterplot.config.variables[].members | array | |
| scatterplot.config.variables[].members[] | object | Inherits: object |
| scatterplot.config.variables[].members[].entityId* | string | |
| scatterplot.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type TablePostRequest (object)
TablePostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.TableSpec |
| config.outputEntityId* | string | |
| config.outputVariable* | array | |
| config.outputVariable[] | object | Inherits: object |
| config.outputVariable[].entityId* | string | |
| config.outputVariable[].variableId* | string | |
| config.pagingConfig* | object | Additional properties: Yes Inherits: object |
| config.pagingConfig.numRows | integer | Format: int64 |
| config.pagingConfig.offset | integer | Format: int64 |
Type TableSpec (object)
TableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| outputVariable* | array | |
| outputVariable[] | object | Inherits: object |
| outputVariable[].entityId* | string | |
| outputVariable[].variableId* | string | |
| pagingConfig* | object | Additional properties: Yes Inherits: object |
| pagingConfig.numRows | integer | Format: int64 |
| pagingConfig.offset | integer | Format: int64 |
Type TablePostResponse (object)
TablePostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| columns* | array | |
| columns[] | object | Inherits: object |
| columns[].entityId* | string | |
| columns[].variableId* | string | |
| rows* | array | |
| rows[] | array | |
| rows[][] | string |
Type TwoByTwoSpec (object)
TwoByTwoSpec
Inherits: lib.MosaicSpec
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string | |
| xAxisReferenceValue* | string | |
| yAxisReferenceValue* | string |
Type TwoByTwoPostRequest (object)
TwoByTwoPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string | |
| config.xAxisReferenceValue* | string | |
| config.yAxisReferenceValue* | string |
Type Statistic (object)
Statistic
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| value* | number | |
| confidenceInterval | string | |
| confidenceLevel | number | |
| pvalue* | string |
Type TwoByTwoStatsTable (object)
TwoByTwoStatsTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| chisq* | object | Inherits: object |
| chisq.value* | number | |
| chisq.confidenceInterval | string | |
| chisq.confidenceLevel | number | |
| chisq.pvalue* | string | |
| fisher* | object | Inherits: object |
| fisher.value* | number | |
| fisher.confidenceInterval | string | |
| fisher.confidenceLevel | number | |
| fisher.pvalue* | string | |
| prevalence | object | Inherits: object |
| prevalence.value* | number | |
| prevalence.confidenceInterval | string | |
| prevalence.confidenceLevel | number | |
| prevalence.pvalue* | string | |
| oddsratio | object | Inherits: object |
| oddsratio.value* | number | |
| oddsratio.confidenceInterval | string | |
| oddsratio.confidenceLevel | number | |
| oddsratio.pvalue* | string | |
| relativerisk | object | Inherits: object |
| relativerisk.value* | number | |
| relativerisk.confidenceInterval | string | |
| relativerisk.confidenceLevel | number | |
| relativerisk.pvalue* | string | |
| sensitivity | object | Inherits: object |
| sensitivity.value* | number | |
| sensitivity.confidenceInterval | string | |
| sensitivity.confidenceLevel | number | |
| sensitivity.pvalue* | string | |
| specificity | object | Inherits: object |
| specificity.value* | number | |
| specificity.confidenceInterval | string | |
| specificity.confidenceLevel | number | |
| specificity.pvalue* | string | |
| posPredictiveValue | object | Inherits: object |
| posPredictiveValue.value* | number | |
| posPredictiveValue.confidenceInterval | string | |
| posPredictiveValue.confidenceLevel | number | |
| posPredictiveValue.pvalue* | string | |
| negPredictiveValue | object | Inherits: object |
| negPredictiveValue.value* | number | |
| negPredictiveValue.confidenceInterval | string | |
| negPredictiveValue.confidenceLevel | number | |
| negPredictiveValue.pvalue* | string |
Type TwoByTwoPostResponse (object)
TwoByTwoPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: lib.Mosaic |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: lib.MosaicData |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.config* | object | Inherits: lib.PlotConfig |
| mosaic.config.completeCasesAllVars* | number | |
| mosaic.config.completeCasesAxesVars* | number | |
| mosaic.config.variables* | array | |
| mosaic.config.variables[] | object | Inherits: object |
| mosaic.config.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.config.variables[].variableSpec* | object | Inherits: object |
| mosaic.config.variables[].variableSpec.entityId* | string | |
| mosaic.config.variables[].variableSpec.variableId* | string | |
| mosaic.config.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataType* | string | Enum:
Inherits: string |
| mosaic.config.variables[].dataShape* | string | Enum:
Inherits: string |
| mosaic.config.variables[].displayName | string | |
| mosaic.config.variables[].displayRangeMin | any | |
| mosaic.config.variables[].displayRangeMax | any | |
| mosaic.config.variables[].vocabulary | array | |
| mosaic.config.variables[].vocabulary[] | string | |
| mosaic.config.variables[].isCollection* | boolean | |
| mosaic.config.variables[].imputeZero* | boolean | |
| mosaic.config.variables[].members | array | |
| mosaic.config.variables[].members[] | object | Inherits: object |
| mosaic.config.variables[].members[].entityId* | string | |
| mosaic.config.variables[].members[].variableId* | string | |
| sampleSizeTable* | array | |
| sampleSizeTable[] | object | Inherits: lib.SampleSizeTable |
| sampleSizeTable[].xVariableDetails | array | |
| sampleSizeTable[].xVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].xVariableDetails[].entityId* | string | |
| sampleSizeTable[].xVariableDetails[].variableId* | string | |
| sampleSizeTable[].xVariableDetails[].value* | string | |
| sampleSizeTable[].overlayVariableDetails | object | Inherits: object |
| sampleSizeTable[].overlayVariableDetails.entityId* | string | |
| sampleSizeTable[].overlayVariableDetails.variableId* | string | |
| sampleSizeTable[].overlayVariableDetails.value* | string | |
| sampleSizeTable[].facetVariableDetails | array | Max. items: 2 |
| sampleSizeTable[].facetVariableDetails[] | object | Inherits: object |
| sampleSizeTable[].facetVariableDetails[].entityId* | string | |
| sampleSizeTable[].facetVariableDetails[].variableId* | string | |
| sampleSizeTable[].facetVariableDetails[].value* | string | |
| sampleSizeTable[].size* | array | |
| sampleSizeTable[].size[] | number | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string | |
| completeCasesTable* | array | |
| completeCasesTable[] | object | Inherits: lib.VariableCompleteCases |
| completeCasesTable[].variableDetails* | object | Inherits: object |
| completeCasesTable[].variableDetails.entityId* | string | |
| completeCasesTable[].variableDetails.variableId* | string | |
| completeCasesTable[].completeCases* | number |
Type BarplotData (object)
BarplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | number | |
| label* | array | |
| label[] | string |
Type MapMarkersOverlayData (object)
MapMarkersOverlayData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | number | |
| label* | array | |
| label[] | string |
Type BoxplotData (object)
BoxplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| lowerfence* | array | |
| lowerfence[] | number | |
| upperfence* | array | |
| upperfence[] | number | |
| q1* | array | |
| q1[] | number | |
| q3* | array | |
| q3[] | number | |
| median* | array | |
| median[] | number | |
| outliers | array | |
| outliers[] | array | |
| outliers[][] | number | |
| rawData | array | |
| rawData[] | array | |
| rawData[][] | number | |
| mean | array | |
| mean[] | number | |
| label* | array | |
| label[] | string |
Type BoxplotStatsTable (object)
BoxplotStatsTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| xVariableDetails | object | Inherits: object |
| xVariableDetails.entityId* | string | |
| xVariableDetails.variableId* | string | |
| xVariableDetails.value* | string | |
| statistic* | string | |
| pvalue* | number | |
| parameter* | array | |
| parameter[] | number | |
| method* | string | |
| statsError* | string |
Type HistogramData (object)
HistogramData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | number | |
| binStart* | array | |
| binStart[] | string | |
| binEnd* | array | |
| binEnd[] | string | |
| binLabel* | array | |
| binLabel[] | string |
Type BinSlider (object)
BinSlider
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | number | |
| max* | number | |
| step* | number |
Type HeatmapData (object)
HeatmapData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| value* | array | |
| value[] | array | |
| value[][] | number | |
| label* | array | |
| label[] | string |
Type MosaicPostRequest (object)
MosaicPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MosaicSpec |
| config.outputEntityId* | string | |
| config.showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.facetVariable | array | Max. items: 2 |
| config.facetVariable[] | object | Inherits: object |
| config.facetVariable[].entityId* | string | |
| config.facetVariable[].variableId* | string |
Type MosaicSpec (object)
MosaicSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: lib.ShowMissingnessNoAxes |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type MosaicData (object)
MosaicData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| xLabel* | array | |
| xLabel[] | string | |
| yLabel* | array | |
| yLabel[] | array | |
| yLabel[][] | string | |
| value* | array | |
| value[] | array | |
| value[][] | number |
Type Mosaic (object)
Mosaic
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].xLabel* | array | |
| data[].xLabel[] | string | |
| data[].yLabel* | array | |
| data[].yLabel[] | array | |
| data[].yLabel[][] | string | |
| data[].value* | array | |
| data[].value[] | array | |
| data[].value[][] | number | |
| config* | object | Inherits: lib.PlotConfig |
| config.completeCasesAllVars* | number | |
| config.completeCasesAxesVars* | number | |
| config.variables* | array | |
| config.variables[] | object | Inherits: object |
| config.variables[].variableClass* | string | Enum:
Inherits: string |
| config.variables[].variableSpec* | object | Inherits: object |
| config.variables[].variableSpec.entityId* | string | |
| config.variables[].variableSpec.variableId* | string | |
| config.variables[].plotReference* | string | Enum:
Inherits: string |
| config.variables[].dataType* | string | Enum:
Inherits: string |
| config.variables[].dataShape* | string | Enum:
Inherits: string |
| config.variables[].displayName | string | |
| config.variables[].displayRangeMin | any | |
| config.variables[].displayRangeMax | any | |
| config.variables[].vocabulary | array | |
| config.variables[].vocabulary[] | string | |
| config.variables[].isCollection* | boolean | |
| config.variables[].imputeZero* | boolean | |
| config.variables[].members | array | |
| config.variables[].members[] | object | Inherits: object |
| config.variables[].members[].entityId* | string | |
| config.variables[].members[].variableId* | string |
Type ScatterplotData (object)
ScatterplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| seriesY* | array | |
| seriesY[] | string | |
| seriesX* | array | |
| seriesX[] | string | |
| smoothedMeanX | array | |
| smoothedMeanX[] | string | |
| smoothedMeanY | array | |
| smoothedMeanY[] | number | |
| smoothedMeanSE | array | |
| smoothedMeanSE[] | number | |
| smoothedMeanError | string | |
| bestFitLineX | array | |
| bestFitLineX[] | string | |
| bestFitLineY | array | |
| bestFitLineY[] | number | |
| r2 | number |
Type DensityplotData (object)
DensityplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| densityY* | array | |
| densityY[] | number | |
| densityX* | array | |
| densityX[] | number |
Type LineplotData (object)
LineplotData
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| seriesY* | array | |
| seriesY[] | string | |
| seriesX* | array | |
| seriesX[] | string | |
| binStart | array | |
| binStart[] | string | |
| binEnd | array | |
| binEnd[] | string | |
| binSampleSize | array | |
| binSampleSize[] | union | Inherits: lib.SampleSize |
| binSampleSize[] | anyOf | Any of the following types. |
| binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| binSampleSize[]{SimpleSampleSize}..N* | number | |
| binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| errorBars | array | |
| errorBars[] | object | Inherits: lib.ErrorBar |
| errorBars[].lowerBound* | number | |
| errorBars[].upperBound* | number | |
| errorBars[].error* | string |
Type PlotConfig (object)
PlotConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| completeCasesAllVars* | number | |
| completeCasesAxesVars* | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type SampleSizeTable (object)
SampleSizeTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| xVariableDetails | array | |
| xVariableDetails[] | object | Inherits: object |
| xVariableDetails[].entityId* | string | |
| xVariableDetails[].variableId* | string | |
| xVariableDetails[].value* | string | |
| overlayVariableDetails | object | Inherits: object |
| overlayVariableDetails.entityId* | string | |
| overlayVariableDetails.variableId* | string | |
| overlayVariableDetails.value* | string | |
| facetVariableDetails | array | Max. items: 2 |
| facetVariableDetails[] | object | Inherits: object |
| facetVariableDetails[].entityId* | string | |
| facetVariableDetails[].variableId* | string | |
| facetVariableDetails[].value* | string | |
| size* | array | |
| size[] | number |
Type VariableCompleteCases (object)
VariableCompleteCases
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableDetails* | object | Inherits: object |
| variableDetails.entityId* | string | |
| variableDetails.variableId* | string | |
| completeCases* | number |
Type CategoricalDistributionPostRequest (object)
CategoricalDistributionPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: object |
| config.entityId* | string | |
| config.variableId* | string |
Type CategoricalDistributionBin (object)
CategoricalDistributionBin
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| label* | string | |
| value* | number |
Type CategoricalDistributionPostResponse (object)
CategoricalDistributionPostResponse
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| countDistribution* | array | |
| countDistribution[] | object | Additional properties: Yes Inherits: object |
| countDistribution[].label* | string | |
| countDistribution[].value* | number | |
| proportionDistribution* | array | |
| proportionDistribution[] | object | Additional properties: Yes Inherits: object |
| proportionDistribution[].label* | string | |
| proportionDistribution[].value* | number |
Type ExampleComputeVizPostRequest (object)
ExampleComputeVizPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.ExampleComputeVizSpec |
| config.prefixVar* | object | Inherits: object |
| config.prefixVar.entityId* | string | |
| config.prefixVar.variableId* | string | |
| computeConfig* | object | Additional properties: Yes Inherits: object |
| computeConfig.inputVariable* | object | Inherits: object |
| computeConfig.inputVariable.entityId* | string | |
| computeConfig.inputVariable.variableId* | string | |
| computeConfig.valueSuffix* | string |
Type ExampleComputeVizSpec (object)
ExampleComputeVizSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| prefixVar* | object | Inherits: object |
| prefixVar.entityId* | string | |
| prefixVar.variableId* | string |
Type ExampleComputeVizPostResponse (object)
ExampleComputeVizPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| countPluginResult* | integer | |
| numEmptyValues* | integer | |
| longestConcatenatedValue* | string | |
| avgConcatenatedLength* | number |
Type MultiStreamPostRequest (object)
MultiStreamPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.MultiStreamSpec |
| config.entityId* | string |
Type MultiStreamSpec (object)
MultiStreamSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string |
Type RecordCountPostRequest (object)
RecordCountPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.RecordCountSpec |
| config.entityId* | string |
Type RecordCountSpec (object)
RecordCountSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string |
Type RecordCountPostResponse (object)
RecordCountPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| recordCount* | integer |
Type TestCollectionsPostRequest (object)
TestCollectionsPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: object |
| config.entityId* | string | |
| config.collectionId* | string |
Type CollectionFloatingBarplotPostRequest (object)
CollectionFloatingBarplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingBarplotSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string |
Type CollectionFloatingBarplotSpec (object)
CollectionFloatingBarplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string |
Type CollectionFloatingBoxplotPostRequest (object)
CollectionFloatingBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingBoxplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type CollectionFloatingBoxplotSpec (object)
CollectionFloatingBoxplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type CollectionFloatingContTablePostRequest (object)
CollectionFloatingContTablePostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingContTableSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: lib.CollectionOverlayConfig |
| config.xAxisVariable.collection* | object | Inherits: object |
| config.xAxisVariable.collection.entityId* | string | |
| config.xAxisVariable.collection.collectionId* | string | |
| config.xAxisVariable.selectedMembers* | array | |
| config.xAxisVariable.selectedMembers[] | object | Inherits: object |
| config.xAxisVariable.selectedMembers[].entityId* | string | |
| config.xAxisVariable.selectedMembers[].variableId* | string |
Type CollectionFloatingContTableSpec (object)
CollectionFloatingContTableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: lib.CollectionOverlayConfig |
| xAxisVariable.collection* | object | Inherits: object |
| xAxisVariable.collection.entityId* | string | |
| xAxisVariable.collection.collectionId* | string | |
| xAxisVariable.selectedMembers* | array | |
| xAxisVariable.selectedMembers[] | object | Inherits: object |
| xAxisVariable.selectedMembers[].entityId* | string | |
| xAxisVariable.selectedMembers[].variableId* | string |
Type CollectionFloatingHistogramPostRequest (object)
CollectionFloatingHistogramPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingHistogramSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type CollectionFloatingHistogramSpec (object)
CollectionFloatingHistogramSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type CollectionFloatingLineplotPostRequest (object)
CollectionFloatingLineplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.CollectionFloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| config.overlayConfig.collection* | object | Inherits: object |
| config.overlayConfig.collection.entityId* | string | |
| config.overlayConfig.collection.collectionId* | string | |
| config.overlayConfig.selectedMembers* | array | |
| config.overlayConfig.selectedMembers[] | object | Inherits: object |
| config.overlayConfig.selectedMembers[].entityId* | string | |
| config.overlayConfig.selectedMembers[].variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type CollectionFloatingLineplotSpec (object)
CollectionFloatingLineplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisNumeratorValues | array | |
| yAxisNumeratorValues[] | string | |
| yAxisDenominatorValues | array | |
| yAxisDenominatorValues[] | string | |
| overlayConfig* | object | Inherits: lib.CollectionOverlayConfig |
| overlayConfig.collection* | object | Inherits: object |
| overlayConfig.collection.entityId* | string | |
| overlayConfig.collection.collectionId* | string | |
| overlayConfig.selectedMembers* | array | |
| overlayConfig.selectedMembers[] | object | Inherits: object |
| overlayConfig.selectedMembers[].entityId* | string | |
| overlayConfig.selectedMembers[].variableId* | string | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| valueSpec* | string | Enum:
|
| errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type StandaloneCollectionMapMarkerPostRequest (object)
StandaloneCollectionMapMarkerPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Specification for a map marker Inherits: lib.StandaloneCollectionMapMarkerSpec |
| config.outputEntityId* | string | Entity ID associated with collection variable of interest. |
| config.geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number | |
| config.collection* | object | Collection variable to use for markers. Inherits: object |
| config.collection.entityId* | string | |
| config.collection.collectionId* | string | |
| config.aggregationConfig* | object | Specification for how variable values will be aggregated into quantiative value shown in bar plot marker. Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| config.aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.aggregationConfig.overlayVariable* | object | Inherits: object |
| config.aggregationConfig.overlayVariable.entityId* | string | |
| config.aggregationConfig.overlayVariable.variableId* | string | |
| config.selectedMemberVariables* | array | Variables in the provided collection for which marker data should be provided. |
| config.selectedMemberVariables[] | object | Inherits: object |
| config.selectedMemberVariables[].entityId* | string | |
| config.selectedMemberVariables[].variableId* | string |
Type StandaloneCollectionMapMarkerSpec (object)
StandaloneCollectionMapMarkerSpec
Specification for a map marker
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | Entity ID associated with collection variable of interest. |
| geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number | |
| collection* | object | Collection variable to use for markers. Inherits: object |
| collection.entityId* | string | |
| collection.collectionId* | string | |
| aggregationConfig* | object | Specification for how variable values will be aggregated into quantiative value shown in bar plot marker. Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| aggregationConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| aggregationConfig.overlayVariable* | object | Inherits: object |
| aggregationConfig.overlayVariable.entityId* | string | |
| aggregationConfig.overlayVariable.variableId* | string | |
| selectedMemberVariables* | array | Variables in the provided collection for which marker data should be provided. |
| selectedMemberVariables[] | object | Inherits: object |
| selectedMemberVariables[].entityId* | string | |
| selectedMemberVariables[].variableId* | string |
Type CollectionMapMarkerElement (object)
CollectionMapMarkerElement
Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| entityCount* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number | |
| values* | array | |
| values[] | object | Additional properties: Yes Inherits: lib.CollectionMemberAggregate |
| values[].variableId* | string | |
| values[].mean* | number | |
| values[].median* | number | |
| values[].confidenceInterval* | object | Inherits: lib.NumberRange |
| values[].confidenceInterval.min* | number | |
| values[].confidenceInterval.max* | number | |
| values[].n* | number |
Type CollectionMemberAggregate (object)
CollectionMemberAggregate
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| variableId* | string | |
| mean* | number | |
| median* | number | |
| confidenceInterval* | object | Inherits: lib.NumberRange |
| confidenceInterval.min* | number | |
| confidenceInterval.max* | number | |
| n* | number |
Type StandaloneCollectionMapMarkerPostResponse (object)
StandaloneCollectionMapMarkerPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| markers* | array | |
| markers[] | object | Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar. Additional properties: Yes Inherits: object |
| markers[].entityCount* | number | |
| markers[].avgLat* | number | |
| markers[].avgLon* | number | |
| markers[].minLat* | number | |
| markers[].minLon* | number | |
| markers[].maxLat* | number | |
| markers[].maxLon* | number | |
| markers[].values* | array | |
| markers[].values[] | object | Additional properties: Yes Inherits: lib.CollectionMemberAggregate |
| markers[].values[].variableId* | string | |
| markers[].values[].mean* | number | |
| markers[].values[].median* | number | |
| markers[].values[].confidenceInterval* | object | Inherits: lib.NumberRange |
| markers[].values[].confidenceInterval.min* | number | |
| markers[].values[].confidenceInterval.max* | number | |
| markers[].values[].n* | number |
Type FloatingBarplotPostRequest (object)
FloatingBarplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingBarplotSpec |
| config.outputEntityId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string |
Type FloatingBarplotSpec (object)
FloatingBarplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string |
Type FloatingBarplot (object)
FloatingBarplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingBarplotPostResponse (object)
FloatingBarplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| barplot* | object | Inherits: object |
| barplot.data* | array | |
| barplot.data[] | object | Inherits: object |
| barplot.data[].overlayVariableDetails | object | Inherits: object |
| barplot.data[].overlayVariableDetails.entityId* | string | |
| barplot.data[].overlayVariableDetails.variableId* | string | |
| barplot.data[].overlayVariableDetails.value* | string | |
| barplot.data[].facetVariableDetails | array | Max. items: 2 |
| barplot.data[].facetVariableDetails[] | object | Inherits: object |
| barplot.data[].facetVariableDetails[].entityId* | string | |
| barplot.data[].facetVariableDetails[].variableId* | string | |
| barplot.data[].facetVariableDetails[].value* | string | |
| barplot.data[].value* | array | |
| barplot.data[].value[] | number | |
| barplot.data[].label* | array | |
| barplot.data[].label[] | string | |
| barplot.variables* | array | |
| barplot.variables[] | object | Inherits: object |
| barplot.variables[].variableClass* | string | Enum:
Inherits: string |
| barplot.variables[].variableSpec* | object | Inherits: object |
| barplot.variables[].variableSpec.entityId* | string | |
| barplot.variables[].variableSpec.variableId* | string | |
| barplot.variables[].plotReference* | string | Enum:
Inherits: string |
| barplot.variables[].dataType* | string | Enum:
Inherits: string |
| barplot.variables[].dataShape* | string | Enum:
Inherits: string |
| barplot.variables[].displayName | string | |
| barplot.variables[].displayRangeMin | any | |
| barplot.variables[].displayRangeMax | any | |
| barplot.variables[].vocabulary | array | |
| barplot.variables[].vocabulary[] | string | |
| barplot.variables[].isCollection* | boolean | |
| barplot.variables[].imputeZero* | boolean | |
| barplot.variables[].members | array | |
| barplot.variables[].members[] | object | Inherits: object |
| barplot.variables[].members[].entityId* | string | |
| barplot.variables[].members[].variableId* | string |
Type FloatingBoxplotPostRequest (object)
FloatingBoxplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingBoxplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type FloatingBoxplotSpec (object)
FloatingBoxplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type FloatingBoxplot (object)
FloatingBoxplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].lowerfence* | array | |
| data[].lowerfence[] | number | |
| data[].upperfence* | array | |
| data[].upperfence[] | number | |
| data[].q1* | array | |
| data[].q1[] | number | |
| data[].q3* | array | |
| data[].q3[] | number | |
| data[].median* | array | |
| data[].median[] | number | |
| data[].outliers | array | |
| data[].outliers[] | array | |
| data[].outliers[][] | number | |
| data[].rawData | array | |
| data[].rawData[] | array | |
| data[].rawData[][] | number | |
| data[].mean | array | |
| data[].mean[] | number | |
| data[].label* | array | |
| data[].label[] | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingBoxplotPostResponse (object)
FloatingBoxplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| boxplot* | object | Inherits: object |
| boxplot.data* | array | |
| boxplot.data[] | object | Inherits: object |
| boxplot.data[].overlayVariableDetails | object | Inherits: object |
| boxplot.data[].overlayVariableDetails.entityId* | string | |
| boxplot.data[].overlayVariableDetails.variableId* | string | |
| boxplot.data[].overlayVariableDetails.value* | string | |
| boxplot.data[].facetVariableDetails | array | Max. items: 2 |
| boxplot.data[].facetVariableDetails[] | object | Inherits: object |
| boxplot.data[].facetVariableDetails[].entityId* | string | |
| boxplot.data[].facetVariableDetails[].variableId* | string | |
| boxplot.data[].facetVariableDetails[].value* | string | |
| boxplot.data[].lowerfence* | array | |
| boxplot.data[].lowerfence[] | number | |
| boxplot.data[].upperfence* | array | |
| boxplot.data[].upperfence[] | number | |
| boxplot.data[].q1* | array | |
| boxplot.data[].q1[] | number | |
| boxplot.data[].q3* | array | |
| boxplot.data[].q3[] | number | |
| boxplot.data[].median* | array | |
| boxplot.data[].median[] | number | |
| boxplot.data[].outliers | array | |
| boxplot.data[].outliers[] | array | |
| boxplot.data[].outliers[][] | number | |
| boxplot.data[].rawData | array | |
| boxplot.data[].rawData[] | array | |
| boxplot.data[].rawData[][] | number | |
| boxplot.data[].mean | array | |
| boxplot.data[].mean[] | number | |
| boxplot.data[].label* | array | |
| boxplot.data[].label[] | string | |
| boxplot.variables* | array | |
| boxplot.variables[] | object | Inherits: object |
| boxplot.variables[].variableClass* | string | Enum:
Inherits: string |
| boxplot.variables[].variableSpec* | object | Inherits: object |
| boxplot.variables[].variableSpec.entityId* | string | |
| boxplot.variables[].variableSpec.variableId* | string | |
| boxplot.variables[].plotReference* | string | Enum:
Inherits: string |
| boxplot.variables[].dataType* | string | Enum:
Inherits: string |
| boxplot.variables[].dataShape* | string | Enum:
Inherits: string |
| boxplot.variables[].displayName | string | |
| boxplot.variables[].displayRangeMin | any | |
| boxplot.variables[].displayRangeMax | any | |
| boxplot.variables[].vocabulary | array | |
| boxplot.variables[].vocabulary[] | string | |
| boxplot.variables[].isCollection* | boolean | |
| boxplot.variables[].imputeZero* | boolean | |
| boxplot.variables[].members | array | |
| boxplot.variables[].members[] | object | Inherits: object |
| boxplot.variables[].members[].entityId* | string | |
| boxplot.variables[].members[].variableId* | string |
Type FloatingContTablePostRequest (object)
FloatingContTablePostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingContTableSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string |
Type FloatingContTableSpec (object)
FloatingContTableSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string |
Type FloatingContTable (object)
FloatingContTable
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].xLabel* | array | |
| data[].xLabel[] | string | |
| data[].yLabel* | array | |
| data[].yLabel[] | array | |
| data[].yLabel[][] | string | |
| data[].value* | array | |
| data[].value[] | array | |
| data[].value[][] | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingContTablePostResponse (object)
FloatingContTablePostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mosaic* | object | Inherits: object |
| mosaic.data* | array | |
| mosaic.data[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails | array | Max. items: 2 |
| mosaic.data[].facetVariableDetails[] | object | Inherits: object |
| mosaic.data[].facetVariableDetails[].entityId* | string | |
| mosaic.data[].facetVariableDetails[].variableId* | string | |
| mosaic.data[].facetVariableDetails[].value* | string | |
| mosaic.data[].xLabel* | array | |
| mosaic.data[].xLabel[] | string | |
| mosaic.data[].yLabel* | array | |
| mosaic.data[].yLabel[] | array | |
| mosaic.data[].yLabel[][] | string | |
| mosaic.data[].value* | array | |
| mosaic.data[].value[] | array | |
| mosaic.data[].value[][] | number | |
| mosaic.variables* | array | |
| mosaic.variables[] | object | Inherits: object |
| mosaic.variables[].variableClass* | string | Enum:
Inherits: string |
| mosaic.variables[].variableSpec* | object | Inherits: object |
| mosaic.variables[].variableSpec.entityId* | string | |
| mosaic.variables[].variableSpec.variableId* | string | |
| mosaic.variables[].plotReference* | string | Enum:
Inherits: string |
| mosaic.variables[].dataType* | string | Enum:
Inherits: string |
| mosaic.variables[].dataShape* | string | Enum:
Inherits: string |
| mosaic.variables[].displayName | string | |
| mosaic.variables[].displayRangeMin | any | |
| mosaic.variables[].displayRangeMax | any | |
| mosaic.variables[].vocabulary | array | |
| mosaic.variables[].vocabulary[] | string | |
| mosaic.variables[].isCollection* | boolean | |
| mosaic.variables[].imputeZero* | boolean | |
| mosaic.variables[].members | array | |
| mosaic.variables[].members[] | object | Inherits: object |
| mosaic.variables[].members[].entityId* | string | |
| mosaic.variables[].members[].variableId* | string | |
| statsTable | array | |
| statsTable[] | object | Inherits: object |
| statsTable[].facetVariableDetails | array | Max. items: 2 |
| statsTable[].facetVariableDetails[] | object | Inherits: object |
| statsTable[].facetVariableDetails[].entityId* | string | |
| statsTable[].facetVariableDetails[].variableId* | string | |
| statsTable[].facetVariableDetails[].value* | string | |
| statsTable[].chisq* | object | Inherits: object |
| statsTable[].chisq.value* | number | |
| statsTable[].chisq.confidenceInterval | string | |
| statsTable[].chisq.confidenceLevel | number | |
| statsTable[].chisq.pvalue* | string | |
| statsTable[].fisher* | object | Inherits: object |
| statsTable[].fisher.value* | number | |
| statsTable[].fisher.confidenceInterval | string | |
| statsTable[].fisher.confidenceLevel | number | |
| statsTable[].fisher.pvalue* | string | |
| statsTable[].prevalence | object | Inherits: object |
| statsTable[].prevalence.value* | number | |
| statsTable[].prevalence.confidenceInterval | string | |
| statsTable[].prevalence.confidenceLevel | number | |
| statsTable[].prevalence.pvalue* | string | |
| statsTable[].oddsratio | object | Inherits: object |
| statsTable[].oddsratio.value* | number | |
| statsTable[].oddsratio.confidenceInterval | string | |
| statsTable[].oddsratio.confidenceLevel | number | |
| statsTable[].oddsratio.pvalue* | string | |
| statsTable[].relativerisk | object | Inherits: object |
| statsTable[].relativerisk.value* | number | |
| statsTable[].relativerisk.confidenceInterval | string | |
| statsTable[].relativerisk.confidenceLevel | number | |
| statsTable[].relativerisk.pvalue* | string | |
| statsTable[].sensitivity | object | Inherits: object |
| statsTable[].sensitivity.value* | number | |
| statsTable[].sensitivity.confidenceInterval | string | |
| statsTable[].sensitivity.confidenceLevel | number | |
| statsTable[].sensitivity.pvalue* | string | |
| statsTable[].specificity | object | Inherits: object |
| statsTable[].specificity.value* | number | |
| statsTable[].specificity.confidenceInterval | string | |
| statsTable[].specificity.confidenceLevel | number | |
| statsTable[].specificity.pvalue* | string | |
| statsTable[].posPredictiveValue | object | Inherits: object |
| statsTable[].posPredictiveValue.value* | number | |
| statsTable[].posPredictiveValue.confidenceInterval | string | |
| statsTable[].posPredictiveValue.confidenceLevel | number | |
| statsTable[].posPredictiveValue.pvalue* | string | |
| statsTable[].negPredictiveValue | object | Inherits: object |
| statsTable[].negPredictiveValue.value* | number | |
| statsTable[].negPredictiveValue.confidenceInterval | string | |
| statsTable[].negPredictiveValue.confidenceLevel | number | |
| statsTable[].negPredictiveValue.pvalue* | string |
Type FloatingHistogramPostRequest (object)
FloatingHistogramPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingHistogramSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.barMode* | string | Enum:
|
| config.valueSpec* | string | Enum:
Inherits: string |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.binSpec* | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type FloatingHistogramSpec (object)
FloatingHistogramSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| barMode* | string | Enum:
|
| valueSpec* | string | Enum:
Inherits: string |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| binSpec* | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type FloatingHistogram (object)
FloatingHistogram
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].value* | array | |
| data[].value[] | number | |
| data[].binStart* | array | |
| data[].binStart[] | string | |
| data[].binEnd* | array | |
| data[].binEnd[] | string | |
| data[].binLabel* | array | |
| data[].binLabel[] | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingHistogramPostResponse (object)
FloatingHistogramPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| histogram* | object | Inherits: object |
| histogram.data* | array | |
| histogram.data[] | object | Inherits: object |
| histogram.data[].overlayVariableDetails | object | Inherits: object |
| histogram.data[].overlayVariableDetails.entityId* | string | |
| histogram.data[].overlayVariableDetails.variableId* | string | |
| histogram.data[].overlayVariableDetails.value* | string | |
| histogram.data[].facetVariableDetails | array | Max. items: 2 |
| histogram.data[].facetVariableDetails[] | object | Inherits: object |
| histogram.data[].facetVariableDetails[].entityId* | string | |
| histogram.data[].facetVariableDetails[].variableId* | string | |
| histogram.data[].facetVariableDetails[].value* | string | |
| histogram.data[].value* | array | |
| histogram.data[].value[] | number | |
| histogram.data[].binStart* | array | |
| histogram.data[].binStart[] | string | |
| histogram.data[].binEnd* | array | |
| histogram.data[].binEnd[] | string | |
| histogram.data[].binLabel* | array | |
| histogram.data[].binLabel[] | string | |
| histogram.variables* | array | |
| histogram.variables[] | object | Inherits: object |
| histogram.variables[].variableClass* | string | Enum:
Inherits: string |
| histogram.variables[].variableSpec* | object | Inherits: object |
| histogram.variables[].variableSpec.entityId* | string | |
| histogram.variables[].variableSpec.variableId* | string | |
| histogram.variables[].plotReference* | string | Enum:
Inherits: string |
| histogram.variables[].dataType* | string | Enum:
Inherits: string |
| histogram.variables[].dataShape* | string | Enum:
Inherits: string |
| histogram.variables[].displayName | string | |
| histogram.variables[].displayRangeMin | any | |
| histogram.variables[].displayRangeMax | any | |
| histogram.variables[].vocabulary | array | |
| histogram.variables[].vocabulary[] | string | |
| histogram.variables[].isCollection* | boolean | |
| histogram.variables[].imputeZero* | boolean | |
| histogram.variables[].members | array | |
| histogram.variables[].members[] | object | Inherits: object |
| histogram.variables[].members[].entityId* | string | |
| histogram.variables[].members[].variableId* | string |
Type FloatingLineplotPostRequest (object)
FloatingLineplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingLineplotSpec |
| config.outputEntityId* | string | |
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.yAxisNumeratorValues | array | |
| config.yAxisNumeratorValues[] | string | |
| config.yAxisDenominatorValues | array | |
| config.yAxisDenominatorValues[] | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.binSpec | object | Inherits: lib.BinSpec |
| config.binSpec.type | string | Enum:
|
| config.binSpec.value | number | |
| config.binSpec.units | string | Enum:
Inherits: string |
| config.binSpec.range | union | |
| config.binSpec.range | anyOf | Any of the following types. |
| config.binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| config.binSpec.range{NumberRange}..min* | number | |
| config.binSpec.range{NumberRange}..max* | number | |
| config.binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| config.binSpec.range{DateRange}..min* | string | |
| config.binSpec.range{DateRange}..max* | string | |
| config.valueSpec* | string | Enum:
|
| config.errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| config.viewport | object | Inherits: lib.NumericViewport |
| config.viewport.xMin* | string | |
| config.viewport.xMax* | string |
Type FloatingLineplotSpec (object)
FloatingLineplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| yAxisNumeratorValues | array | |
| yAxisNumeratorValues[] | string | |
| yAxisDenominatorValues | array | |
| yAxisDenominatorValues[] | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| binSpec | object | Inherits: lib.BinSpec |
| binSpec.type | string | Enum:
|
| binSpec.value | number | |
| binSpec.units | string | Enum:
Inherits: string |
| binSpec.range | union | |
| binSpec.range | anyOf | Any of the following types. |
| binSpec.range{NumberRange} | object | Inherits: lib.NumberRange |
| binSpec.range{NumberRange}..min* | number | |
| binSpec.range{NumberRange}..max* | number | |
| binSpec.range{DateRange} | object | Inherits: lib.DateRange |
| binSpec.range{DateRange}..min* | string | |
| binSpec.range{DateRange}..max* | string | |
| valueSpec* | string | Enum:
|
| errorBars* | string | Enum:
Inherits: lib.StringBoolean |
| viewport | object | Inherits: lib.NumericViewport |
| viewport.xMin* | string | |
| viewport.xMax* | string |
Type FloatingLineplot (object)
FloatingLineplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].binStart | array | |
| data[].binStart[] | string | |
| data[].binEnd | array | |
| data[].binEnd[] | string | |
| data[].binSampleSize | array | |
| data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| data[].binSampleSize[] | anyOf | Any of the following types. |
| data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| data[].errorBars | array | |
| data[].errorBars[] | object | Inherits: lib.ErrorBar |
| data[].errorBars[].lowerBound* | number | |
| data[].errorBars[].upperBound* | number | |
| data[].errorBars[].error* | string | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingLineplotPostResponse (object)
FloatingLineplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| lineplot* | object | Inherits: object |
| lineplot.data* | array | |
| lineplot.data[] | object | Inherits: object |
| lineplot.data[].overlayVariableDetails | object | Inherits: object |
| lineplot.data[].overlayVariableDetails.entityId* | string | |
| lineplot.data[].overlayVariableDetails.variableId* | string | |
| lineplot.data[].overlayVariableDetails.value* | string | |
| lineplot.data[].facetVariableDetails | array | Max. items: 2 |
| lineplot.data[].facetVariableDetails[] | object | Inherits: object |
| lineplot.data[].facetVariableDetails[].entityId* | string | |
| lineplot.data[].facetVariableDetails[].variableId* | string | |
| lineplot.data[].facetVariableDetails[].value* | string | |
| lineplot.data[].seriesY* | array | |
| lineplot.data[].seriesY[] | string | |
| lineplot.data[].seriesX* | array | |
| lineplot.data[].seriesX[] | string | |
| lineplot.data[].binStart | array | |
| lineplot.data[].binStart[] | string | |
| lineplot.data[].binEnd | array | |
| lineplot.data[].binEnd[] | string | |
| lineplot.data[].binSampleSize | array | |
| lineplot.data[].binSampleSize[] | union | Inherits: lib.SampleSize |
| lineplot.data[].binSampleSize[] | anyOf | Any of the following types. |
| lineplot.data[].binSampleSize[]{SimpleSampleSize} | object | Inherits: lib.SimpleSampleSize |
| lineplot.data[].binSampleSize[]{SimpleSampleSize}..N* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize} | object | Inherits: lib.ProportionSampleSize |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN* | number | |
| lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN* | number | |
| lineplot.data[].errorBars | array | |
| lineplot.data[].errorBars[] | object | Inherits: lib.ErrorBar |
| lineplot.data[].errorBars[].lowerBound* | number | |
| lineplot.data[].errorBars[].upperBound* | number | |
| lineplot.data[].errorBars[].error* | string | |
| lineplot.variables* | array | |
| lineplot.variables[] | object | Inherits: object |
| lineplot.variables[].variableClass* | string | Enum:
Inherits: string |
| lineplot.variables[].variableSpec* | object | Inherits: object |
| lineplot.variables[].variableSpec.entityId* | string | |
| lineplot.variables[].variableSpec.variableId* | string | |
| lineplot.variables[].plotReference* | string | Enum:
Inherits: string |
| lineplot.variables[].dataType* | string | Enum:
Inherits: string |
| lineplot.variables[].dataShape* | string | Enum:
Inherits: string |
| lineplot.variables[].displayName | string | |
| lineplot.variables[].displayRangeMin | any | |
| lineplot.variables[].displayRangeMax | any | |
| lineplot.variables[].vocabulary | array | |
| lineplot.variables[].vocabulary[] | string | |
| lineplot.variables[].isCollection* | boolean | |
| lineplot.variables[].imputeZero* | boolean | |
| lineplot.variables[].members | array | |
| lineplot.variables[].members[] | object | Inherits: object |
| lineplot.variables[].members[].entityId* | string | |
| lineplot.variables[].members[].variableId* | string |
Type FloatingScatterplotPostRequest (object)
FloatingScatterplotPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.FloatingScatterplotSpec |
| config.outputEntityId* | string | |
| config.valueSpec* | string | Enum:
|
| config.xAxisVariable* | object | Inherits: object |
| config.xAxisVariable.entityId* | string | |
| config.xAxisVariable.variableId* | string | |
| config.yAxisVariable* | object | Inherits: object |
| config.yAxisVariable.entityId* | string | |
| config.yAxisVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.maxAllowedDataPoints | integer | Format: int64 |
Type FloatingScatterplotSpec (object)
FloatingScatterplotSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| yAxisVariable* | object | Inherits: object |
| yAxisVariable.entityId* | string | |
| yAxisVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| maxAllowedDataPoints | integer | Format: int64 |
Type FloatingScatterplot (object)
FloatingScatterplot
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| data* | array | |
| data[] | object | Inherits: object |
| data[].overlayVariableDetails | object | Inherits: object |
| data[].overlayVariableDetails.entityId* | string | |
| data[].overlayVariableDetails.variableId* | string | |
| data[].overlayVariableDetails.value* | string | |
| data[].facetVariableDetails | array | Max. items: 2 |
| data[].facetVariableDetails[] | object | Inherits: object |
| data[].facetVariableDetails[].entityId* | string | |
| data[].facetVariableDetails[].variableId* | string | |
| data[].facetVariableDetails[].value* | string | |
| data[].seriesY* | array | |
| data[].seriesY[] | string | |
| data[].seriesX* | array | |
| data[].seriesX[] | string | |
| data[].smoothedMeanX | array | |
| data[].smoothedMeanX[] | string | |
| data[].smoothedMeanY | array | |
| data[].smoothedMeanY[] | number | |
| data[].smoothedMeanSE | array | |
| data[].smoothedMeanSE[] | number | |
| data[].smoothedMeanError | string | |
| data[].bestFitLineX | array | |
| data[].bestFitLineX[] | string | |
| data[].bestFitLineY | array | |
| data[].bestFitLineY[] | number | |
| data[].r2 | number | |
| variables* | array | |
| variables[] | object | Inherits: object |
| variables[].variableClass* | string | Enum:
Inherits: string |
| variables[].variableSpec* | object | Inherits: object |
| variables[].variableSpec.entityId* | string | |
| variables[].variableSpec.variableId* | string | |
| variables[].plotReference* | string | Enum:
Inherits: string |
| variables[].dataType* | string | Enum:
Inherits: string |
| variables[].dataShape* | string | Enum:
Inherits: string |
| variables[].displayName | string | |
| variables[].displayRangeMin | any | |
| variables[].displayRangeMax | any | |
| variables[].vocabulary | array | |
| variables[].vocabulary[] | string | |
| variables[].isCollection* | boolean | |
| variables[].imputeZero* | boolean | |
| variables[].members | array | |
| variables[].members[] | object | Inherits: object |
| variables[].members[].entityId* | string | |
| variables[].members[].variableId* | string |
Type FloatingScatterplotPostResponse (object)
FloatingScatterplotPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| scatterplot* | object | Inherits: object |
| scatterplot.data* | array | |
| scatterplot.data[] | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails | object | Inherits: object |
| scatterplot.data[].overlayVariableDetails.entityId* | string | |
| scatterplot.data[].overlayVariableDetails.variableId* | string | |
| scatterplot.data[].overlayVariableDetails.value* | string | |
| scatterplot.data[].facetVariableDetails | array | Max. items: 2 |
| scatterplot.data[].facetVariableDetails[] | object | Inherits: object |
| scatterplot.data[].facetVariableDetails[].entityId* | string | |
| scatterplot.data[].facetVariableDetails[].variableId* | string | |
| scatterplot.data[].facetVariableDetails[].value* | string | |
| scatterplot.data[].seriesY* | array | |
| scatterplot.data[].seriesY[] | string | |
| scatterplot.data[].seriesX* | array | |
| scatterplot.data[].seriesX[] | string | |
| scatterplot.data[].smoothedMeanX | array | |
| scatterplot.data[].smoothedMeanX[] | string | |
| scatterplot.data[].smoothedMeanY | array | |
| scatterplot.data[].smoothedMeanY[] | number | |
| scatterplot.data[].smoothedMeanSE | array | |
| scatterplot.data[].smoothedMeanSE[] | number | |
| scatterplot.data[].smoothedMeanError | string | |
| scatterplot.data[].bestFitLineX | array | |
| scatterplot.data[].bestFitLineX[] | string | |
| scatterplot.data[].bestFitLineY | array | |
| scatterplot.data[].bestFitLineY[] | number | |
| scatterplot.data[].r2 | number | |
| scatterplot.variables* | array | |
| scatterplot.variables[] | object | Inherits: object |
| scatterplot.variables[].variableClass* | string | Enum:
Inherits: string |
| scatterplot.variables[].variableSpec* | object | Inherits: object |
| scatterplot.variables[].variableSpec.entityId* | string | |
| scatterplot.variables[].variableSpec.variableId* | string | |
| scatterplot.variables[].plotReference* | string | Enum:
Inherits: string |
| scatterplot.variables[].dataType* | string | Enum:
Inherits: string |
| scatterplot.variables[].dataShape* | string | Enum:
Inherits: string |
| scatterplot.variables[].displayName | string | |
| scatterplot.variables[].displayRangeMin | any | |
| scatterplot.variables[].displayRangeMax | any | |
| scatterplot.variables[].vocabulary | array | |
| scatterplot.variables[].vocabulary[] | string | |
| scatterplot.variables[].isCollection* | boolean | |
| scatterplot.variables[].imputeZero* | boolean | |
| scatterplot.variables[].members | array | |
| scatterplot.variables[].members[] | object | Inherits: object |
| scatterplot.variables[].members[].entityId* | string | |
| scatterplot.variables[].members[].variableId* | string |
Type StandaloneMapBubblesLegendPostRequest (object)
StandaloneMapBubblesLegendPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.StandaloneMapBubblesLegendSpec |
| config.outputEntityId* | string | |
| config.colorLegendConfig* | object | Inherits: lib.OverlayLegendConfig |
| config.colorLegendConfig.geoAggregateVariable* | object | Inherits: object |
| config.colorLegendConfig.geoAggregateVariable.entityId* | string | |
| config.colorLegendConfig.geoAggregateVariable.variableId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* | string | |
| config.sizeConfig* | object | Inherits: lib.SizeLegendConfig |
| config.sizeConfig.geoAggregateVariable* | object | Inherits: object |
| config.sizeConfig.geoAggregateVariable.entityId* | string | |
| config.sizeConfig.geoAggregateVariable.variableId* | string |
Type StandaloneMapBubblesLegendSpec (object)
StandaloneMapBubblesLegendSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| colorLegendConfig* | object | Inherits: lib.OverlayLegendConfig |
| colorLegendConfig.geoAggregateVariable* | object | Inherits: object |
| colorLegendConfig.geoAggregateVariable.entityId* | string | |
| colorLegendConfig.geoAggregateVariable.variableId* | string | |
| colorLegendConfig.quantitativeOverlayConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| colorLegendConfig.quantitativeOverlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| colorLegendConfig.quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId* | string | |
| sizeConfig* | object | Inherits: lib.SizeLegendConfig |
| sizeConfig.geoAggregateVariable* | object | Inherits: object |
| sizeConfig.geoAggregateVariable.entityId* | string | |
| sizeConfig.geoAggregateVariable.variableId* | string |
Type OverlayLegendConfig (object)
OverlayLegendConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| quantitativeOverlayConfig* | object | Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| quantitativeOverlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| quantitativeOverlayConfig.overlayVariable* | object | Inherits: object |
| quantitativeOverlayConfig.overlayVariable.entityId* | string | |
| quantitativeOverlayConfig.overlayVariable.variableId* | string |
Type SizeLegendConfig (object)
SizeLegendConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string |
Type StandaloneMapBubblesLegendPostResponse (object)
StandaloneMapBubblesLegendPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| minColorValue* | number | |
| maxColorValue* | number | |
| minSizeValue* | number | |
| maxSizeValue* | number |
Type StandaloneMapBubblesPostRequest (object)
StandaloneMapBubblesPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Specification for map bubbles. Inherits: lib.StandaloneMapBubblesSpec |
| config.outputEntityId* | string | Entity whose cardinality will be reported per marker. |
| config.geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.overlayConfig | object | Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers. Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type StandaloneMapBubblesSpec (object)
StandaloneMapBubblesSpec
Specification for map bubbles.
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | Entity whose cardinality will be reported per marker. |
| geoAggregateVariable* | object | Geohash component variable to group markers by. This is usually determined by zoom level of the client application. Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Variable representing longitude of output entity. Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Variable representing latitude of output entity. Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| overlayConfig | object | Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers. Discriminator: overlayType Inherits: lib.QuantitativeOverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| valueSpec* | string | Enum:
Inherits: string |
| viewport* | object | Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers. Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type StandaloneMapBubblesPostResponse (object)
StandaloneMapBubblesPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.ColoredMapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].overlayValue* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number |
Type ColoredMapElementInfo (object)
ColoredMapElementInfo
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateValue* | string | |
| entityCount* | number | |
| overlayValue* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number |
Type StandaloneMapMarkersPostRequest (object)
StandaloneMapMarkersPostRequest
Inherits: lib.DataPluginRequestBase
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
| config* | object | Inherits: lib.StandaloneMapMarkersSpec |
| config.outputEntityId* | string | |
| config.geoAggregateVariable* | object | Inherits: object |
| config.geoAggregateVariable.entityId* | string | |
| config.geoAggregateVariable.variableId* | string | |
| config.longitudeVariable* | object | Inherits: object |
| config.longitudeVariable.entityId* | string | |
| config.longitudeVariable.variableId* | string | |
| config.latitudeVariable* | object | Inherits: object |
| config.latitudeVariable.entityId* | string | |
| config.latitudeVariable.variableId* | string | |
| config.overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| config.overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| config.overlayConfig.overlayVariable* | object | Inherits: object |
| config.overlayConfig.overlayVariable.entityId* | string | |
| config.overlayConfig.overlayVariable.variableId* | string | |
| config.valueSpec* | string | Enum:
Inherits: string |
| config.viewport* | object | Inherits: lib.GeolocationViewport |
| config.viewport.latitude* | object | Inherits: lib.NumericViewport |
| config.viewport.latitude.xMin* | string | |
| config.viewport.latitude.xMax* | string | |
| config.viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| config.viewport.longitude.left* | number | |
| config.viewport.longitude.right* | number |
Type StandaloneMapMarkersSpec (object)
StandaloneMapMarkersSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| geoAggregateVariable* | object | Inherits: object |
| geoAggregateVariable.entityId* | string | |
| geoAggregateVariable.variableId* | string | |
| longitudeVariable* | object | Inherits: object |
| longitudeVariable.entityId* | string | |
| longitudeVariable.variableId* | string | |
| latitudeVariable* | object | Inherits: object |
| latitudeVariable.entityId* | string | |
| latitudeVariable.variableId* | string | |
| overlayConfig | object | Discriminator: overlayType Inherits: lib.OverlayConfig |
| overlayConfig.overlayType* | string | Enum:
Inherits: lib.OverlayType |
| overlayConfig.overlayVariable* | object | Inherits: object |
| overlayConfig.overlayVariable.entityId* | string | |
| overlayConfig.overlayVariable.variableId* | string | |
| valueSpec* | string | Enum:
Inherits: string |
| viewport* | object | Inherits: lib.GeolocationViewport |
| viewport.latitude* | object | Inherits: lib.NumericViewport |
| viewport.latitude.xMin* | string | |
| viewport.latitude.xMax* | string | |
| viewport.longitude* | object | Inherits: lib.LongitudeViewport |
| viewport.longitude.left* | number | |
| viewport.longitude.right* | number |
Type StandaloneMapMarkersPostResponse (object)
StandaloneMapMarkersPostResponse
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| mapElements* | array | |
| mapElements[] | object | Inherits: lib.StandaloneMapElementInfo |
| mapElements[].geoAggregateValue* | string | |
| mapElements[].entityCount* | number | |
| mapElements[].overlayValues* | array | |
| mapElements[].overlayValues[] | object | Inherits: lib.BinRange |
| mapElements[].overlayValues[].binStart* | string | |
| mapElements[].overlayValues[].binEnd* | string | |
| mapElements[].overlayValues[].binLabel* | string | |
| mapElements[].overlayValues[].value* | number | |
| mapElements[].overlayValues[].count* | number | |
| mapElements[].avgLat* | number | |
| mapElements[].avgLon* | number | |
| mapElements[].minLat* | number | |
| mapElements[].minLon* | number | |
| mapElements[].maxLat* | number | |
| mapElements[].maxLon* | number |
Type OverlayType (string)
OverlayType
Enum:
- continuous
- categorical
Inherits: string
Type OverlayConfig (object)
OverlayConfig
Discriminator: overlayType
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string |
Type ContinousOverlayConfig (object)
ContinousOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| overlayValues* | array | |
| overlayValues[] | object | Inherits: object |
| overlayValues[].binStart* | string | |
| overlayValues[].binEnd* | string | |
| overlayValues[].binLabel* | string |
Type CategoricalOverlayConfig (object)
CategoricalOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| overlayValues* | array | |
| overlayValues[] | string |
Type RangeWithCountAndValue (object)
RangeWithCountAndValue
Inherits: lib.BinRangeWithValue
Model
| Parameter | Type | Description |
|---|---|---|
| binStart* | string | |
| binEnd* | string | |
| binLabel* | string | |
| value* | number | |
| count* | number |
Type StandaloneMapElementInfo (object)
StandaloneMapElementInfo
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| geoAggregateValue* | string | |
| entityCount* | number | |
| overlayValues* | array | |
| overlayValues[] | object | Inherits: lib.BinRangeWithValue |
| overlayValues[].binStart* | string | |
| overlayValues[].binEnd* | string | |
| overlayValues[].binLabel* | string | |
| overlayValues[].value* | number | |
| overlayValues[].count* | number | |
| avgLat* | number | |
| avgLon* | number | |
| minLat* | number | |
| minLon* | number | |
| maxLat* | number | |
| maxLon* | number |
Type DataPluginRequestBase (object)
DataPluginRequestBase
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| studyId* | string | |
| filters | array | |
| filters[] | object | Additional properties: Yes Discriminator: type Inherits: object |
| filters[].entityId* | string | |
| filters[].type* | string | Enum:
Inherits: lib.API_FilterType |
| derivedVariables | array | |
| derivedVariables[] | object | Inherits: lib.VariableSpec |
| derivedVariables[].entityId* | string | |
| derivedVariables[].variableId* | string | |
| derivedVariables[].expectedVariableType* | string | Enum:
Inherits: lib.API_VariableType |
| derivedVariables[].expectedVariableDataShape* | string | Enum:
Inherits: lib.API_VariableDataShape |
| derivedVariables[].functionName* | string | |
| derivedVariables[].inputVars* | array | |
| derivedVariables[].inputVars[] | object | Inherits: object |
| derivedVariables[].inputVars[].entityId* | string | |
| derivedVariables[].inputVars[].variableId* | string | |
| derivedVariables[].config* | object | Additional properties: Yes |
Type EmptyDataPluginSpec (object)
EmptyDataPluginSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|
Type StringBoolean (string)
StringBoolean
Enum:
- TRUE
- FALSE
Inherits: string
Type StrataVariableDetails (object)
StrataVariableDetails
Inherits: lib.VariableSpec
Model
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | |
| variableId* | string | |
| value* | string |
Type BinSpec (object)
BinSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| type | string | Enum:
|
| value | number | |
| units | string | Enum:
Inherits: string |
| range | union | |
| range | anyOf | Any of the following types. |
| range{NumberRange} | object | Inherits: lib.NumberRange |
| range{NumberRange}..min* | number | |
| range{NumberRange}..max* | number | |
| range{DateRange} | object | Inherits: lib.DateRange |
| range{DateRange}..min* | string | |
| range{DateRange}..max* | string |
Type NumberRange (object)
NumberRange
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | number | |
| max* | number |
Type DateRange (object)
DateRange
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| min* | string | |
| max* | string |
Type NumericViewport (object)
NumericViewport
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| xMin* | string | |
| xMax* | string |
Type LongitudeViewport (object)
LongitudeViewport
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| left* | number | |
| right* | number |
Type GeolocationViewport (object)
GeolocationViewport
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| latitude* | object | Inherits: object |
| latitude.xMin* | string | |
| latitude.xMax* | string | |
| longitude* | object | Inherits: object |
| longitude.left* | number | |
| longitude.right* | number |
Type ErrorBar (object)
ErrorBar
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| lowerBound* | number | |
| upperBound* | number | |
| error* | string |
Type SimpleSampleSize (object)
SimpleSampleSize
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| N* | number |
Type ProportionSampleSize (object)
ProportionSampleSize
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| numeratorN* | number | |
| denominatorN* | number |
Type SampleSize (union)
SampleSize
Inherits: lib.SimpleSampleSize | lib.ProportionSampleSize
Model
| Parameter | Type | Description |
|---|---|---|
| anyOf | Any of the following types. | |
| {SimpleSampleSize} | object | Inherits: object |
| {SimpleSampleSize}.N* | number | |
| {ProportionSampleSize} | object | Inherits: object |
| {ProportionSampleSize}.numeratorN* | number | |
| {ProportionSampleSize}.denominatorN* | number |
Type ShowMissingness (string)
ShowMissingness
Enum:
- allVariables
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type ShowMissingnessNoAxes (string)
ShowMissingnessNoAxes
Enum:
- strataVariables
- noVariables
- TRUE
- FALSE
Inherits: string
Type BoxplotWith1ComputeSpec (object)
BoxplotWith1ComputeSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: string |
| points* | string | Enum:
|
| mean* | string | Enum:
Inherits: string |
| computeStats* | string | Enum:
Inherits: string |
| xAxisVariable | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type ScatterplotWith1ComputeSpec (object)
ScatterplotWith1ComputeSpec
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| outputEntityId* | string | |
| showMissingness | string | Enum:
Inherits: string |
| valueSpec* | string | Enum:
|
| xAxisVariable* | object | Inherits: object |
| xAxisVariable.entityId* | string | |
| xAxisVariable.variableId* | string | |
| overlayVariable | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| facetVariable | array | Max. items: 2 |
| facetVariable[] | object | Inherits: object |
| facetVariable[].entityId* | string | |
| facetVariable[].variableId* | string |
Type Aggregator (string)
Aggregator
Enum:
- mean
- median
Inherits: string
Type QuantitativeOverlayConfig (object)
QuantitativeOverlayConfig
Discriminator: overlayType
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string |
Type ContinuousQuantitativeOverlayConfig (object)
ContinuousQuantitativeOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| aggregator* | string | Enum:
Inherits: string |
Type CategoricalQuantitativeOverlayConfig (object)
CategoricalQuantitativeOverlayConfig
Model
| Parameter | Type | Description |
|---|---|---|
| overlayType* | string | Enum:
Inherits: string |
| overlayVariable* | object | Inherits: object |
| overlayVariable.entityId* | string | |
| overlayVariable.variableId* | string | |
| numeratorValues* | array | |
| numeratorValues[] | string | |
| denominatorValues* | array | |
| denominatorValues[] | string |
Type CollectionOverlayConfig (object)
CollectionOverlayConfig
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| collection* | object | Inherits: object |
| collection.entityId* | string | |
| collection.collectionId* | string | |
| selectedMembers* | array | |
| selectedMembers[] | object | Inherits: object |
| selectedMembers[].entityId* | string | |
| selectedMembers[].variableId* | string |
Type Error (object)
Error
Discriminator: status
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Type ErrorType (string)
ErrorType
Enum:
- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: string
Type BadRequestError (object)
Bad Request
Request could not be parsed or was otherwise unusable.
Discriminator: status
Discriminator value: bad-request
Inherits: error.Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Examples
{
"status": "bad-request",
"message": "malformed JSON"
}Type UnauthorizedError (object)
Unauthorized
Unauthenticated client requested a resource that requires authentication.
Discriminator: status
Discriminator value: unauthorized
Inherits: error.Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Examples
{
"status": "unauthorized",
"message": "users must be logged in to access this resource"
}Type ForbiddenError (object)
Forbidden
Server understood the request but is refusing it.
Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.
Discriminator: status
Discriminator value: forbidden
Inherits: error.Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Examples
{
"status": "forbidden",
"message": "the current user is not permitted to perform this action"
}Type NotFoundError (object)
Not Found
The requested resource was not found on this server.
Discriminator: status
Discriminator value: not-found
Inherits: error.Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Examples
{
"status": "not-found",
"message": "the requested resource could not be found"
}Type MethodNotAllowedError (object)
Method Not Allowed
The HTTP method used to request a resource is not allowed or configured by the server.
Discriminator: status
Discriminator value: bad-method
Inherits: error.Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string |
Examples
{
"status": "bad-method",
"message": "PUT requests are not permitted on this endpoint"
}Type UnprocessableEntityError (object)
Unprocessable Entity
The request payload or parameters are correctly structured but fail resource specific validation.
Discriminator: status
Discriminator value: invalid-input
Inherits: error.Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string | |
| errors* | object | Additional properties: Yes |
| errors.general* | array | Non-field specific errors. |
| errors.general[] | string | |
| errors.byKey* | object | Field specific errors Additional properties: Yes |
| errors.byKey.//* | array | |
| errors.byKey.//[] | string |
Examples
{
"status": "invalid-input",
"message": "JSON validation failed",
"errors": {
"general": [],
"byKey": {
"id": [
"Given ID value does not point to an existing record."
]
}
}
}Type ServerError (object)
Internal Server Error
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: error.ErrorType |
| message* | string | |
| requestId* | string |
Examples
{
"status": "server-error",
"message": "Datastore connection lost",
"requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}Type HealthResponse (object)
HealthResponse
Health details about the service
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| status* | string | Status describes the overall service state. A status of "healthy" indicates that everything is running smoothly and all service dependencies are reachable and online. A status of "unhealthy" indicates that something is wrong with either this service or one or more of it's dependency services. Enum:
|
| dependencies* | array | A list of external services that this service depends on and some details about them. |
| dependencies[] | object | Inherits: DependencyStatus |
| dependencies[].name* | string | Name of the external depdendency. |
| dependencies[].reachable* | boolean | Whether or not the external service is reachable. |
| dependencies[].online* | string | Whether or not the external service is online and available for requests. Enum:
|
| info* | object | Additional properties: Yes |
| info.threads* | integer | Min. value: 1 |
| info.uptime* | string | |
| info.uptimeMillis* | integer | Min. value: 1 Format: int64 |
Type DependencyStatus (object)
DependencyStatus
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | Name of the external depdendency. |
| reachable* | boolean | Whether or not the external service is reachable. |
| online* | string | Whether or not the external service is online and available for requests. Enum:
|